标的集合
数据集标识:ref.instrument_sets;证券对象标识示例:000001.SZ
按集合族登记的标的集合成员与生效区间。规则用 instrument_set_id 只对当日属于该集合的标的生效;同一集合族内的集合互斥,一个标的在任一交易日至多属于其中一个,同一集合内的同一标的区间不重叠。集合是数据:接入新市场或新的波动控制安排只新增登记行,不改规则结构。
业务主键:instrument_set_id、asset_id、valid_from,每行取值唯一。
接口
| 用途 | 方法与路径 |
|---|---|
| 查询数据 | POST /v1/datasets/ref.instrument_sets/query |
| 契约与当前发布 | GET /v1/datasets/ref.instrument_sets |
| 准备批量快照 | POST /v1/datasets/ref.instrument_sets/preparations |
请求参数
可在请求体 where 中作为 field 使用的筛选参数,名称保持契约原名。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
start_date | date | 否 | 按生效日期筛选,查询开始日期,包含该日。 |
end_date | date | 否 | 按生效日期筛选,查询结束日期,包含该日。 |
返回字段
列名保持契约原名,可直接用于 select、where 与结果行。
| 字段名 | 中文名称 | 类型 | 可空 | 说明 |
|---|---|---|---|---|
instrument_set_id | 集合标识 | string | 否 | 集合标识,小写 kebab-case,在数据集内标识一个集合;规则以 instrument_set_id 引用。 |
set_family | 集合族 | string | 否 | 集合族标识,小写 snake_case;同一集合族内的集合互斥,一个标的在任一交易日至多属于其中一个,不同集合族之间不互斥。 |
asset_id | 成员标的 | string | 否 | 成员标的的 asset_id,写法见规格 063(<场所码>:<代码>)。 |
valid_from | 生效日期 | date | 否 | 规则生效日,包含该日。 |
valid_to | 失效日期 | date | 是 | 规则失效日,不含该日;为空表示至今有效。 |
basis_document | 依据文件 | string | 否 | 规则依据的业务规则名称与条款摘要。 |
evidence_sha256 | 依据原件哈希 | string | 是 | 依据原件内容的 sha256;尚未取得原件时为空。 |
verification_status | 核验状态 | string | 否 | verified 已有依据原件,unverified 尚未取得依据原件。 |
字段补充属性
括号中是契约描述(GET /v1/datasets/{datasetId} 的 fields)里的键名。
| 字段名 | 属性 |
|---|---|
verification_status | 枚举(allowedValues):["verified", "unverified"] |
请求示例
向 https://api.<环境域名>/v1/datasets/ref.instrument_sets/query 发送 POST 请求(服务地址的替换方式见快速开始),请求头为 Authorization: Bearer <API_KEY> 与 Content-Type: application/json,请求体如下:
{
"select": [
"instrument_set_id",
"asset_id",
"valid_from",
"set_family"
],
"where": [
{
"field": "instrument_set_id",
"op": "eq",
"value": "xhkg-vcm-designated"
},
{
"field": "valid_from",
"op": "gte",
"value": "2016-08-22"
},
{
"field": "valid_from",
"op": "lte",
"value": "2016-08-22"
}
],
"page": {
"limit": 1000,
"cursor": null
}
}
响应示例
实际结果随数据更新而变化;data 为空数组表示请求范围内没有可返回的记录。
{
"datasetId": "ref.instrument_sets",
"fields": [
"instrument_set_id",
"asset_id",
"valid_from",
"set_family"
],
"data": [
{
"asset_id": "XHKG:00700",
"instrument_set_id": "xhkg-vcm-designated",
"set_family": "hk_vcm",
"valid_from": "2016-08-22"
}
],
"page": {
"nextCursor": null,
"complete": true
}
}