美股指数搜索

公开接口

指数行情 Index · 美股指数搜索

按关键词搜索美股指数,按匹配相关度排序返回,适合输入框实时联想。

接口地址

GET /us/index/search
完整地址:https://api.databull.cn/us/index/search

接口说明

按关键词搜索美股指数,按**匹配相关度**排序返回,适合输入框实时联想。

相关度优先级:代码完全相等 > 代码后缀相等 > 代码前缀 > 名称完全相等 > 名称前缀 > 名称包含。因此搜 GSPC 时「标普500」排第一,而不是被一堆恰好含该串的指数淹没。

keyword 为必填,同时匹配清单代码(I:SPX)、简称(GSPC)与英文名,大小写不敏感。

返回的每条除清单字段外还带 category(分类)与 display_name(中文名)。没搜到时返回空数组与 empty_reason=no_match。

请求参数

参数位置类型必填默认说明
keyword查询string是—搜索关键词(必填):清单代码(I:SPX)、简称(GSPC)或名称
limit查询integer否20返回条数上限,1~100;取值 1~100
category查询string否分类过滤:broad / total_return / exchange / volatility;留空不过滤
quote_ready_only查询boolean否false只返回行情已验证可取的指数

返回字段

字段类型说明
codenumber业务状态码,0 表示成功
dataarray指数记录数组,按相关度排序;结构同「美股指数列表」的 items

接口示例

cURL
curl "https://api.databull.cn/us/index/search?keyword=GSPC" \
  -H "Authorization: Bearer $DATABULL_API_KEY"
Python
from databull import DataBull

client = DataBull(api_key="YOUR_API_KEY")
result = client.search_us_index(keyword="GSPC", limit=20)
print(result)

响应示例

JSON
{
  "code": 0,
  "data": [
    {
      "id": 3,
      "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"
    }
  ]
}

错误码

状态码触发条件
401缺少或无效 API 凭证
400category 取值非法
403当前套餐不包含该市场数据,升级套餐后可用

说明

  • keyword 为必填,同时匹配清单代码(I:SPX)、简称(GSPC)与名称,大小写不敏感。
  • 相关度优先级:代码完全相等 > 代码后缀相等 > 代码前缀 > 名称完全相等 > 名称前缀 > 名称包含。因此搜 GSPC 时「标普500」排第一,而不是被一堆恰好含该串的指数淹没。
  • 与「美股指数列表」的区别:本接口 keyword 必填且按相关度排序,列表接口则是按代码升序的严格过滤,两者互补。
  • 没搜到任何指数时 data 为空数组并返回 empty_reason: no_match。
  • 该接口属于「美股」数据域,需付费套餐(专业版及以上)方可调用;免费版仅覆盖 A 股。