派生序列定义

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

派生序列的登记：以 series_id = <场所码>:<品种代码>@<规则码>.<名次> 标识一条连续合约等序列，名次从 1 起（1 为主力或近月）。派生序列不是场所挂牌的标的，不占 asset_id；序列本身没有业务生效区间，登记即长期有效，换月由 ref.series_mappings 逐日给出。

业务主键：series_id，每行取值唯一。

接口

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

请求参数

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

参数名	类型	必填	说明
无	-	否	无额外参数。

返回字段

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

字段名	中文名称	类型	可空	说明
series_id	序列标识	string	否	<场所码>:<品种代码>@<规则码>.<名次>；@ 不在 asset_id 的代码字符集内，series_id 不会被 asset_id 解析器接受。
venue	场所	string	否	交易场所码：ISO 10383 MIC（如 XSHG 上海证券交易所），无 MIC 的场所用 BQ 开头的登记码。
product_code	品种代码	string	否	场所内的品种代码，语法同 asset_id 的代码字符集。
rule_code	规则码	string	否	引用的 ref.series_rules 规则码。
series_rank	名次	integer	否	序列名次，从 1 起；1 为主力或近月，2 为次主力或次近月。
basis_document	依据文件	string	否	规则依据的业务规则名称与条款摘要。
evidence_sha256	依据原件哈希	string	是	依据原件内容的 sha256；尚未取得原件时为空。
verification_status	核验状态	string	否	verified 已有依据原件，unverified 尚未取得依据原件。

字段补充属性

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

字段名	属性
venue	标准（standard）：ISO 10383
verification_status	枚举（allowedValues）：["verified", "unverified"]

请求示例

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

{
  "select": [
    "series_id",
    "venue",
    "product_code",
    "rule_code",
    "series_rank"
  ],
  "page": {
    "limit": 1000,
    "cursor": null
  }
}

响应示例

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

{
  "datasetId": "ref.series_definitions",
  "fields": [
    "series_id",
    "venue",
    "product_code",
    "rule_code",
    "series_rank"
  ],
  "data": [
    {
      "product_code": "IF",
      "rule_code": "dominant",
      "series_id": "CCFX:IF@dominant.1",
      "series_rank": 1,
      "venue": "CCFX"
    }
  ],
  "page": {
    "nextCursor": null,
    "complete": true
  }
}