GETsymbol-search
品种代码查询
支持按名称、拼音首字母或分类查询全球股票、期货、外汇及数字货币等金融品种的合约代码,返回匹配的品种列表。
接入文档
接口能力
本接口提供全球金融市场的品种代码查询服务。支持通过模糊关键字(如名称、拼音首字母、代码片段)或指定分类(如美股、港股、外汇、期货、数字货币等)检索对应的合约代码。针对期货分类,还支持筛选主力合约。
请求与返回
- 请求参数:需提供
pidx(页码,每页最多50条)。rout(分类,如 USST, HKST, CMDTY 等)和keywords(模糊关键字)至少输入其一。针对期货可传入futmain筛选主力合约。 - 返回结果:返回符合检索条件的品种列表,包含合约代码、名称及所属分类等基础信息,便于开发者进行后续的行情获取或图表展示。
使用场景
- 金融终端开发:在股票、期货或外汇行情软件中,提供品种搜索与添加自选功能。
- 量化分析平台:辅助用户通过名称快速查找对应的标准化合约代码,以便进行数据回测。
- 财经资讯网站:在文章或页面中自动匹配并关联对应的金融品种代码。
使用说明与限制
rout和keywords必须至少输入一个,否则无法进行有效检索。- 模糊查询可能返回较多结果,建议结合分类参数
rout进行精准过滤。 - 本接口仅提供品种基础代码信息检索,不包含实时行情报价。返回的合约代码格式需根据具体行情接口的要求进行适配。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"pidx": "页码,每页最多50",
"rout": "分类rout和keywords两参数中至少输入其中一个,参考(CNST,USST,HKST,GBFSB,GBCFD,GBFT,CNFT,GBDC,GBIDX,C...",
"keywords": "模糊关键字,拼音首字母/代码等(rout和keywords两参数中必须至少输入其中一个)",
"futmain": "是否筛选主力合约(1是0否),针对期货分类有效"
}响应示例
{}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.pidx | object | {...} |
| properties.pidx.type | string | int |
| properties.pidx.description | string | 页码,每页最多50 |
| properties.rout | object | {...} |
| properties.rout.type | string | string |
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |