请求产品列表
获取指定交易所当前可用的产品列表。返回的交易所代码和产品代码可用于行情、K 线及 WebSocket 订阅。
接口信息
| 项目 | 内容 |
|---|
| 接口路径 | /all_symbol |
| 请求方法 | GET |
| 鉴权 | 需要 |
| 返回格式 | JSON |
| 分页 | 不支持 |
请求参数
| 参数 | 位置 | 类型 | 必填 | 实际参数 | 说明 |
|---|
market | Query | string | 是 | 交易所代码,参考 3.7 | 指定需要获取产品列表的交易所 |
请求格式:
/all_symbol?market={market}
market 必须使用系统支持的交易所代码,并保持原有大小写。
返回结构
| 字段 | 类型 | 说明 |
|---|
State | integer | 业务状态 |
Code | integer/string | 业务代码 |
Msg | string | 状态说明 |
data | array | 产品列表 |
产品字段
| 字段 | 类型 | 允许为空 | 说明 |
|---|
data[].market | string | 否 | 产品所属交易所代码 |
data[].code | string | 否 | 产品代码 |
data[].data | object | 否 | 产品详细信息 |
data[].data.Market | string | 否 | 产品所属交易所代码 |
data[].data.code | string | 否 | 产品代码 |
data[].data.name | string | 是 | 产品名称 |
data[].data.contract | string | 是 | 合约月份或合约标识 |
data[].data.Varieties | string | 是 | 产品类型或品种 |
字段名称区分大小写,客户端必须按照实际字段名读取。
接口行为
- 一次请求只能获取一个交易所的产品列表。
- 产品列表不支持分页。
- 返回顺序不固定,不能依赖数组位置识别产品。
- 调用其他接口时,应使用产品列表返回的交易所代码和产品代码。
- 产品列表可能包含大量数据,建议在客户端缓存并定期更新。
空数据
返回空数组可能表示:
- 交易所代码无效;
- 账号没有该交易所的数据权限;
- 当前交易所没有可用产品;
- 服务端暂时没有产品数据。
客户端应同时检查业务状态、交易所代码和账号权限。
错误处理
| 情况 | 客户端处理 |
|---|
| 未传或错误的访问密钥 | 检查鉴权信息 |
缺少 market | 补充必填参数 |
| 交易所代码无效 | 参考 3.7 核对交易所代码 |
| 返回空数组 | 检查交易所代码和账号权限 |
HTTP 状态码为 200 不一定表示业务成功,客户端还需要检查响应中的业务状态字段。