接入文档
接口简介
本接口提供国内期货市场(内盘)合约基础信息查询服务。开发者传入标准的期货品种代码(symbol),即可获取对应的合约列表,包含合约代码及中文全称(如“上海原油2407”)。数据源自阿里云市场上游服务,适用于需要标准化期货品种标识的业务系统。
适用场景
- 金融终端开发:在交易软件或行情系统中展示标准化的合约名称。
- 数据清洗与映射:将内部系统的简写代码转换为通用的中文合约名称。
- 量化策略回测:构建策略时自动匹配历史合约的代码与名称对应关系。
- 资讯聚合平台:确保展示的期货品种名称符合国内市场规范。
请求与返回说明
请求方式:POST 请求参数:
symbol(必填, string):期货品种代码,需参考官方或上游提供的代码表,例如 "SC0"。
返回结果:
code(number):状态码,200 表示成功。msg(string):状态描述。taskNo(string):本次请求的唯一追踪号。data.list(array):合约列表数组。symbol(string):合约代码。name(string):合约中文名称,包含品种、交易所及到期月份信息。
接入建议
- 代码规范性:请确保传入的
symbol严格符合上游定义的格式,大小写敏感,否则可能导致查询为空。 - 缓存策略:期货合约列表变更频率较低(主要在换月或新合约上市时),建议对返回结果进行本地缓存(如 TTL 设置为 24 小时),以减少 API 调用次数并提升响应速度。
- 异常处理:务必检查返回的
code字段,非 200 状态码时请根据msg提示进行日志记录或用户提示,避免直接解析data导致空指针异常。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "期货品种代码,详见代码表"
}响应示例
{
"msg": "成功",
"taskNo": "075556736233047430019762",
"code": 200,
"data": {
"list": [
{
"symbol": "SC0",
"name": "上海原油2407"
}
]
}
}请求字段
以下字段根据示例 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.taskNo | object | {...} |