接入文档
接口简介
本接口用于查询国内交易所上市的贵金属期货合约基础信息。通过传入品种标识,返回对应的合约代码(symbol)及中文名称(name),帮助开发者构建标准化的交易标的映射表。
适用场景
- 金融终端开发:自动同步上期所黄金、白银等主力及非主力合约列表。
- 量化策略系统:动态获取可交易合约代码,避免硬编码导致的合约过期错误。
- 行情数据展示:为用户提供清晰的合约选择下拉菜单,显示标准合约名称。
请求与返回说明
- 请求方式:POST
- 关键参数:
symbol(必填),指定贵金属品种类型。 - 返回结构:
code/msg:接口状态码及描述。data.list:合约数组,包含symbol(如 AU2412)和name(如 黄金2412)。
接入建议
- 缓存机制:合约列表变更频率较低(通常在换月期),建议本地缓存 24 小时以减少调用成本。
- 异常处理:请校验返回的
code是否为 200,并妥善处理空列表情况。 - 数据映射:利用返回的
symbol作为唯一键,关联实时行情或历史数据接口。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "国内贵金属品种,详见国内贵金属现货,详见国内贵金属期货"
}响应示例
{
"code": 200,
"msg": "成功",
"taskNo": "668229506174286233793097",
"data": {
"list": [
{
"symbol": "AU0",
"name": "黄金2412"
},
{
"symbol": "AU2412",
"name": "黄金2412"
}
]
}
}请求字段
以下字段根据示例 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.code | object | {...} |
| properties.code.type | string | number |
| properties.code.example | number | 200 |
| properties.code.description | string | 返回码对应描述 |
| properties.msg | object | {...} |