指数概况

数据集标识：index.overview；证券对象标识示例：000001.SZ

全球股票、债券、商品及其他指数的名称、代码、编制机构和发布状态。

接口

用途	方法与路径
查询数据	POST /v1/datasets/index.overview/query
契约与当前发布	GET /v1/datasets/index.overview
准备批量快照	POST /v1/datasets/index.overview/preparations

请求参数

可在请求体 where 中作为 field 使用的筛选参数，名称保持契约原名。

参数名	类型	必填	说明
index_code	string	否	筛选一个或多个指数代码。
market	string	否	市场代码；中文客户端默认 CN。

返回字段

列名保持契约原名，可直接用于 select、where 与结果行。

字段名	中文名称	类型	可空	说明
index_code	指数代码	string	否	BuQuant 指数代码。
index_name	指数简称	string	否	指数当前使用的简称。
full_name	指数全称	string	是	指数正式全称。
english_name	英文名称	string	是	指数英文名称。
index_type	指数类型	string	否	宽基、行业、主题、策略、商品或其他指数类型。
asset_class	资产类别	string	是	指数衡量的主要资产类别。
market	市场	string	否	指数主要覆盖的市场；跨市场指数可以为 GLOBAL。
publisher	编制机构	string	否	指数编制或发布机构。
currency	基准币种	string	是	指数点位使用的 ISO 4217 币种代码。
base_date	基日	date	是	指数基准点位对应的日期。
base_value	基点	decimal	是	指数在基日设定的基准点位。
launch_date	发布日期	date	是	指数首次正式发布的日期。
termination_date	终止日期	date	是	指数终止发布的日期。
weighting_method	加权方法	string	是	市值、等权或其他成分加权方法。
rebalance_frequency	调样频率	string	是	指数定期调样频率。
constituent_count	成分数量	integer	是	当前指数成分数量。
publication_status	发布状态	string	否	指数当前发布、暂停或终止状态。
local_code	本地代码	string	是	本地代码
description	指数说明	string	是	指数说明
classification_level	分类层级	string	是	分类层级
benchmark_tier	基准库分层	string	是	基准库分层
benchmark_type	基准类型	string	是	基准类型

字段补充属性

括号中是契约描述（GET /v1/datasets/{datasetId} 的 fields）里的键名。

字段名	属性
base_value	精度（precision）：38；小数位数（scale）：18

请求示例

向 https://api.<环境域名>/v1/datasets/index.overview/query 发送 POST 请求（服务地址的替换方式见快速开始），请求头为 Authorization: Bearer <API_KEY> 与 Content-Type: application/json，请求体如下：

{
  "select": [
    "index_code",
    "index_name",
    "full_name",
    "english_name",
    "index_type",
    "asset_class",
    "market",
    "publisher"
  ],
  "where": [
    {
      "field": "market",
      "op": "eq",
      "value": "CN"
    }
  ],
  "page": {
    "limit": 1000,
    "cursor": null
  }
}

响应示例

实际结果随数据更新而变化；data 为空数组表示请求范围内没有可返回的记录。

{
  "datasetId": "index.overview",
  "fields": [
    "index_code",
    "index_name",
    "full_name",
    "english_name",
    "index_type",
    "asset_class",
    "market",
    "publisher"
  ],
  "data": [],
  "page": {
    "nextCursor": null,
    "complete": true
  }
}