跳到主要内容

标的主数据

数据集标识:ref.instruments;证券对象标识示例:000001.SZ

每行是一个 asset_id 在一段生效区间内的属性;更名、转板、最小交易单位调整、退市等任一属性变化即起新段。另设永不复用的 instrument_id,交易所回收代码时前后两个标的的 instrument_id 不同、区间不相交。板块、子类只取交易所或编制方依据,不按代码段推断;各资产类别的必填字段由资产类别登记决定。

业务主键:asset_id、valid_from、available_at,每行取值唯一。

接口​

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

请求参数​

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

参数名类型必填说明
asset_idstring否标的标识,例如 XSHE:000001。
start_datedate否按生效日期筛选,查询开始日期,包含该日。
end_datedate否按生效日期筛选,查询结束日期,包含该日。

返回字段​

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

字段名中文名称类型可空说明
instrument_id终身标识string否BuQuant 在标的首次登记时分配的不透明标识,永不改变、永不复用;代码变更与转换场所不改变它,合并、分拆产生的新标的取新值。跨日期引用标的时按日期把 asset_id 解析为它。
asset_id标的标识string否与市场无关的标的标识,格式为 <场所码>:<代码>,场所码为运营 MIC 或 BQ 开头的登记码,例如 XSHE:000001。同一 asset_id 在任一时点只属于一个 instrument_id。
venue场所string否交易场所码,由 asset_id 的场所段派生。
market市场string否场所所属市场码,由场所登记派生,例如 CN。
symbol场所内代码string否asset_id 冒号后的场所内代码。
security_code展示别名string是场所登记的展示别名,例如 000001.SZ;无展示后缀的场所为空。
asset_class资产类别string否资产类别登记值,如 stock 股票、etf 交易型开放式基金、index 指数。
asset_subclass资产子类string是资产子类登记值;需要子类区分规则的类别(如 stock、etf、fund)必填,取基金合同类别、跟踪指数或交易所分类依据,不按代码段推断。
market_segment板块string是场所板块登记值,如 main 主板、star 科创板、chinext 创业板、bse 北交所;转板起新段。资产类别登记要求的类别必填。
product_code品种代码string是衍生品所属品种代码,如期货品种 IF;非衍生品为空。
instrument_name名称string否场所公布的证券简称或编制方公布的指数名称。
instrument_name_english英文名称string是场所或编制方公布的英文名称。
isinISINstring是国际证券识别码。
cfi_codeCFI 代码string是金融工具分类码。
quote_currency计价币种string是价格的计价币种,须在场所允许的计价币种内。
settlement_currency结算币种string是交收使用的币种。
base_currency基础币种string是外汇与加密资产的基础币种;其他类别为空。
price_quote_type报价方式string是per_unit 每股或每份价格,percent_of_par 面值百分比,yield 收益率,points 指数点或期货点数,fx_rate 每单位基础币种的计价币种数。
quantity_unit数量单位string是数量单位登记值:share 股或份(股票与 ETF 均为 share,与行情数据集一致),unit 份额单位(其他基金),contract 张。
lot_size每手数量decimal是一手的数量,单位见 quantity_unit。
listing_status上市状态string否pre_listing 待上市,listed 上市,suspended 长期停牌,delisting_period 退市整理期,delisted 已退市;日内与单日停牌不在本表。
listing_date上市日期date是首次上市交易日;指数为空。
delisting_date退市日期date是终止上市日期;未退市为空。
is_tradable是否可交易boolean否该段内是否可交易:资产类别不可交易(如指数)、待上市或已退市时为否。
valid_from生效日期date否该段属性开始生效的日期,包含该日。
valid_to失效日期date是该段属性失效的日期,不含该日;为空表示仍有效。
available_at可知时间timestamp否该行信息首次公开可知的时刻(UTC),取依据公告或来源发布的时刻。同一段的更正以新行表达,按查询时点取不晚于它的最新一行。
is_retracted是否撤回boolean否该行是否撤回此前同键的行;撤回行自其可知时间起使该段在时点视图中消失。
basis_document依据文件string否该行的依据:交易所或编制方的公告、名单或来源端点。
evidence_sha256依据原件哈希string是依据原件内容的 sha256;尚未取得原件时为空。
verification_status核验状态string否verified 已有依据原件,unverified 尚未取得依据原件。

字段补充属性​

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

字段名属性
venue标准(standard):ISO 10383
isin标准(standard):ISO 6166
cfi_code标准(standard):ISO 10962
quote_currency标准(standard):ISO 4217
settlement_currency标准(standard):ISO 4217
base_currency标准(standard):ISO 4217
price_quote_type枚举(allowedValues):["per_unit", "percent_of_par", "yield", "points", "fx_rate"]
lot_size精度(precision):38;小数位数(scale):10;单位(unit):quantity_unit
listing_status枚举(allowedValues):["pre_listing", "listed", "suspended", "delisting_period", "delisted"]
verification_status枚举(allowedValues):["verified", "unverified"]

请求示例​

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

{
"select": [
"instrument_id",
"asset_id",
"asset_class",
"asset_subclass",
"market_segment",
"valid_from",
"valid_to",
"listing_status"
],
"where": [
{
"field": "asset_id",
"op": "eq",
"value": "XSHG:688001"
},
{
"field": "valid_from",
"op": "gte",
"value": "2019-07-22"
},
{
"field": "valid_from",
"op": "lte",
"value": "2026-10-29"
}
],
"page": {
"limit": 1000,
"cursor": null
}
}

响应示例​

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

{
"datasetId": "ref.instruments",
"fields": [
"instrument_id",
"asset_id",
"asset_class",
"asset_subclass",
"market_segment",
"valid_from",
"valid_to",
"listing_status"
],
"data": [],
"page": {
"nextCursor": null,
"complete": true
}
}