跳到主要内容

派生序列换月规则

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

连续合约等派生序列的换月规则：一组带版本的参数对象，按规则码登记。参数一经发布不再修改，改参数即登记新的规则码，从而得到新的 series_id，已发布的映射不变。换月只按参考交易日之前的收盘数据决定，日内不切换。

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

接口​

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

请求参数​

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

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

返回字段​

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

字段名中文名称类型可空说明
rule_code规则码string否换月规则码，小写 snake_case 或 kebab-case，指向一个参数版本；同一规则码的参数不可更改。
roll_basis换月依据string否calendar 按到期日提前换月，volume 按成交量，open_interest 按持仓量，volume_and_open_interest 要求成交量与持仓量同时超过阈值。
candidate_scope候选范围string否all_listed 全部挂牌合约，nearest_n 到期日最近的若干合约。
candidate_count候选合约数integer是nearest_n 时参与比较的合约数，按到期日由近到远；all_listed 时为空。
threshold_ratio切换阈值decimal是新合约的成交量或持仓量须超过当前合约的倍数（如 1.1）；按日历换月时为空。
allow_revert允许回切boolean否是否允许回切到更早到期的合约；为假时只能换到到期更晚的合约。
exclude_last_trade_days到期前停选交易日integer否到期前多少个交易日内不得成为换月目标（0 表示不限制）。
days_before_expiry提前换月交易日integer是按日历换月时提前的交易日数；其他换月依据时为空。
rule_version规则版本string否本条规则参数的 sha256（规则码与八个参数），参数改动而规则码不变即校验失败。
basis_document依据文件string否规则依据的业务规则名称与条款摘要。
evidence_sha256依据原件哈希string是依据原件内容的 sha256；尚未取得原件时为空。
verification_status核验状态string否verified 已有依据原件，unverified 尚未取得依据原件。

字段补充属性​

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

字段名属性
roll_basis枚举（allowedValues）：["calendar", "volume", "open_interest", "volume_and_open_interest"]
candidate_scope枚举（allowedValues）：["all_listed", "nearest_n"]
threshold_ratio精度（precision）：38；小数位数（scale）：18；单位（unit）：ratio
verification_status枚举（allowedValues）：["verified", "unverified"]

请求示例​

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

{
  "select": [
    "rule_code",
    "roll_basis",
    "candidate_scope",
    "threshold_ratio",
    "allow_revert"
  ],
  "page": {
    "limit": 1000,
    "cursor": null
  }
}

响应示例​

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

{
  "datasetId": "ref.series_rules",
  "fields": [
    "rule_code",
    "roll_basis",
    "candidate_scope",
    "threshold_ratio",
    "allow_revert"
  ],
  "data": [
    {
      "allow_revert": false,
      "candidate_scope": "nearest_n",
      "roll_basis": "open_interest",
      "rule_code": "dominant",
      "threshold_ratio": "1.100000000000000000"
    }
  ],
  "page": {
    "nextCursor": null,
    "complete": true
  }
}