接入文档
接口简介
本接口用于查询指定外盘期货品种下的所有可交易合约代码。开发者传入标准品种代码(如 GASO),即可获取包含主力合约及远月合约在内的完整合约列表,适用于行情系统初始化及合约切换逻辑。
适用场景
- 行情软件开发:自动拉取特定品种下的所有活跃合约,构建自选列表。
- 量化策略回测:批量获取历史合约代码,确保回测数据连续性。
- 交易终端集成:为用户提供合约选择器,展示当前可交易的月份合约。
请求与返回说明
- 请求方式:POST
- 核心参数:
symbol(必填),即期货品种代码,需参考平台提供的代码表传入。 - 返回结果:成功时
code为 200,data.list数组中包含该品种下的所有合约代码字符串(例如["GASO2408", "GASO2409"])。
接入建议
- 缓存机制:合约列表变更频率较低,建议在本地或 Redis 中缓存结果,减少重复调用。
- 代码校验:请确保传入的
symbol为有效的外盘品种代码,否则可能返回空列表或错误码。 - 异常处理:务必解析
code和msg字段,针对非 200 状态码进行重试或日志记录。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "期货品种代码,详见代码表"
}响应示例
{
"msg": "成功",
"code": 200,
"taskNo": "906962467150026863697586",
"data": {
"list": [
"GASO",
"GASO2408",
"GASO2409",
"GASO2410",
"GASO2411",
"GASO2412",
"GASO2501",
"GASO2502",
"GASO2503",
"GASO2504",
"GASO2505",
"GASO2506",
"GASO2507",
"GASO2508",
"GASO2509",
"GASO2510",
"GASO2512"
]
}
}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.symbol | object | {...} |
| properties.symbol.type | string | string |
| properties.symbol.description | string | 期货品种代码,详见代码表 |
| required | array | "symbol" |
| required[] | string | symbol |
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.msg | object | {...} |
| properties.msg.type | string | string |
| properties.msg.example | string | 成功 |
| properties.msg.description | string | 返回码对应描述 |
| properties.code | object | {...} |