美股指数列表
公开接口指数行情 Index · 美股指数列表
分页返回美股指数清单,每条含指数代码、名称与行情可用性标记,可用作查询美股指数行情前的主键映射表。
接口地址
GET /us/index/list完整地址:
https://api.databull.cn/us/index/list接口说明
分页返回美股指数清单。清单每日自动同步,覆盖全球主要指数编制方的指数产品,**必须分页**(默认 100/页,最大 500);结果按指数代码升序,翻页稳定不重复、不遗漏。
每条含 symbol(清单代码,如 I:SPX)、name(指数名称)、market、locale、active,以及两个行情相关标记:
- quote_symbol:该指数的行情查询代码(如 I:SPX → GSPC),为空表示暂不支持行情;
- quote_ready:1 表示行情已验证可取,0 表示仅有清单、行情暂不可取。
⚠️ **清单收录 ≠ 行情可取**:清单里大部分指数没有行情,用 /us/index/history 查询前建议先看 quote_ready,或用 quote_ready_only=true 只筛出可查行情的指数。
可按 category 过滤分类(broad 宽基 / total_return 全收益 / exchange 交易所 / volatility 波动率),按 keyword 过滤代码与名称。
请求参数
参数位置类型必填默认说明
q查询string否关键词,模糊匹配指数代码或名称;留空返回全量category查询string否分类过滤:broad 宽基 / total_return 全收益 / exchange 交易所 / volatility 波动率;留空不过滤quote_ready_only查询boolean否false只返回行情已验证可取的指数page查询integer否1页码,从 1 开始;不小于 1page_size查询integer否100每页条数,1~500;取值 1~500返回字段
字段类型说明
codenumber业务状态码,0 表示成功dataobject分页结果对象data.itemsarray指数记录数组,按 symbol 升序data.items[].symbolstring指数代码(清单代码),如 I:SPXdata.items[].quote_symbolstring行情查询代码,如 I:SPX → GSPC;为空表示暂不支持行情data.items[].namestring指数名称(英文原名)data.items[].display_namestring指数中文名;未收录映射时为空data.items[].categorystring分类:broad 宽基 / total_return 全收益 / exchange 交易所 / volatility 波动率;未收录映射时为空data.items[].quote_readynumber行情是否已验证可取:1 可取,0 不可取data.items[].market / locale / activestring市场标识 / 地区 / 是否活跃data.totalnumber满足筛选条件的总条数data.page / data.page_size / data.pagesnumber当前页码 / 每页条数 / 总页数empty_reasonstring仅当 items 为空时出现,标注为空的原因(见下)接口示例
cURL
curl "https://api.databull.cn/us/index/list?category=broad" \
-H "Authorization: Bearer $DATABULL_API_KEY"Python
from databull import DataBull
client = DataBull(api_key="YOUR_API_KEY")
result = client.get_us_index_list(quote_ready_only=True, page=1, page_size=100)
print(result)响应示例
JSON
{
"code": 0,
"data": {
"items": [
{
"id": 1,
"symbol": "I:COMP",
"name": "NASDAQ Composite",
"market": "indices",
"locale": "us",
"active": 1,
"quote_ready": 1,
"quote_symbol": "IXIC",
"category": "broad",
"display_name": "纳斯达克综合指数"
},
{
"id": 2,
"symbol": "I:SPX",
"name": "Standard & Poor's 500",
"market": "indices",
"locale": "us",
"active": 1,
"quote_ready": 1,
"quote_symbol": "GSPC",
"category": "broad",
"display_name": "标普500"
}
],
"total": 11,
"page": 1,
"page_size": 100,
"pages": 1
}
}错误码
状态码触发条件
401缺少或无效 API 凭证
400category 取值非法
403当前套餐不包含该市场数据,升级套餐后可用
说明
- 响应为
{"code": 0, "data": {...}}信封结构。 - 美股指数清单每日自动同步,全量约 1.3 万条,覆盖全球主要指数编制方的产品。
- ⚠️ 清单收录 ≠ 行情可取:清单里大部分指数没有行情数据。每条的
quote_ready标记行情是否可用,quote_symbol是它的行情查询代码。查历史行情前建议先看这两个字段,或传quote_ready_only=true只筛出可查行情的指数(当前 11 只)。 - 必须分页(默认 100/页,最大 500);结果按 symbol 升序,翻页稳定不重复、不遗漏。
q同时匹配清单代码、行情代码与名称,大小写不敏感(如gspc/I:SPX都能命中)。- 清单为空时(尚未同步)返回
empty_reason: catalog_not_synced;筛选无命中返回no_match;页码越界返回page_out_of_range。 - 该接口属于「美股」数据域,需付费套餐(专业版及以上)方可调用;免费版仅覆盖 A 股。
Esc