接入文档
接口简介
本接口用于查询国际贵金属(如白银 SI 等)的期货合约代码列表。开发者传入指定的贵金属品种标识(symbol),即可获取该品种下所有可交易的期货合约代码数组,辅助构建交易标的选择器或行情订阅基础数据。
适用场景
- 金融终端开发:在用户选择查看某类贵金属行情时,动态加载对应的期货合约选项。
- 量化交易系统:初始化阶段获取全量合约代码,用于后续的历史数据拉取或实时行情订阅。
- 投资教育平台:展示不同月份到期的贵金属期货合约结构,帮助用户理解展期规则。
请求与返回说明
- 请求方式:POST
- 核心参数:
symbol(必填),字符串类型,代表国际贵金属品种代码(例如 "SI" 代表白银)。需确保传入的代码符合国际通用标准或上游支持的枚举值。 - 返回结果:
code:状态码,200 表示成功。data.list:字符串数组,包含该品种下的所有期货合约代码(如 "SI2411", "SI2501" 等,通常由品种代码+年月组成)。taskNo:本次请求的唯一追踪 ID,便于问题排查。
接入建议
- 缓存策略:期货合约列表变更频率较低(通常在换月或新合约上市时变动),建议对返回结果进行本地缓存(如有效期 24 小时),以减少 API 调用次数并提升响应速度。
- 参数校验:前端应限制
symbol的输入范围,仅允许传入已知的贵金属品种代码,避免无效请求。 - 错误处理:请根据
code和msg字段处理异常情况,特别是当传入不支持的品种代码时,接口可能返回非 200 状态码或空列表。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "国际贵金属品种,详见国际贵金属现货,详见国际贵金属期货"
}响应示例
{
"code": 200,
"msg": "成功",
"taskNo": "251234402215985750524304",
"data": {
"list": [
"SI",
"SI2411",
"SI2412",
"SI2501",
"SI2503",
"SI2505",
"SI2507",
"SI2509",
"SI2512"
]
}
}请求字段
以下字段根据示例 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 | {...} |