接入文档
接口简介
本接口用于获取指定美股市场的交易品种列表。通过传入市场代码(如纽交所、纳斯达克或美交所),返回对应的股票代码(Symbol)及中文名称。数据适用于构建美股行情基础数据库或前端选股器。
适用场景
- 金融终端开发:初始化美股股票下拉选择框或搜索索引。
- 量化策略回测:获取特定交易所的全量标的池,用于筛选可交易对象。
- 资讯聚合应用:建立股票代码与中文名称的映射关系,提升用户阅读体验。
请求与返回说明
- 请求方式:POST
- 核心参数:
market(必填),枚举值包括nu(纽交所)、ou(纳斯达克)、au(美交所)。 - 返回结构:标准 JSON 格式。成功时
code为 200,data.list数组中包含对象,每个对象含symbol(股票代码)和name(中文名称)。
接入建议
- 缓存策略:美股上市品种变更频率相对较低,建议对返回结果进行本地缓存(如每日更新一次),以减少 API 调用次数并降低延迟。
- 异常处理:请校验返回的
code字段,非 200 状态码时记录msg信息以便排查问题。 - 数据清洗:返回的股票名称可能包含特殊字符或较长描述,前端展示时建议做截断或格式化处理的兼容。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"market": "市场,au 美交所 ,nu 纽交所 ,ou 纳斯达克"
}响应示例
{
"msg": "成功",
"code": 200,
"taskNo": "644761017176228998465587",
"data": {
"list": [
{
"symbol": "gdxu",
"name": "金矿指数3倍做多ETN"
},
{
"symbol": "evav",
"name": "2倍做多电动和自动驾驶汽车ETF-Direxion"
}
]
}
}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.market | object | {...} |
| properties.market.type | string | string |
| properties.market.description | string | 市场,au 美交所 ,nu 纽交所 ,ou 纳斯达克 |
| required | array | "market" |
| required[] | string | market |
响应字段
以下字段根据示例 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 | {...} |