浏览全部文档

Equities API 参考

通过 REST 和 MCP 获取每日数据,另提供八只 USD 股票的付费 WebSocket 流。

操作

发送 Authorization: Bearer YOUR_API_KEYhttps://api.narwhalapi.com。MCP 可通过以下地址访问 /mcp。请使用发现接口返回的真实金融工具 ID。

GET 路径MCP 工具
/v1/equities/instrumentsequities_list_instruments
/v1/equities/instruments/{instrument_id}equities_get_instrument
/v1/equities/instruments/{instrument_id}/barsequities_get_bars
curl "https://api.narwhalapi.com/v1/equities/instruments?symbol=AAPL" \
  -H "Authorization: Bearer $NARWHAL_API_KEY"

参数

发现接口接受可选的 symbol, mic_codecountry,另加 page (默认值为 1)和 outputsize (默认值为 100,最大值为 5,000)。

柱状数据要求 instrument_id。支持的值为 interval=1dayadjust=splits。可选 start_dateend_date 使用 YYYY-MM-DD。 outputsize 默认值为 30,最大值为 5,000。

响应与限制

发现和详情接口返回 count, datastatus。每个金融工具都包含 ID、代码、名称、币种、交易所、MIC、国家和普通股类型。

柱状数据返回 meta, valuesstatus。元数据包括币种、交易所时区和 MIC。数值部分包含 datetime, open, high, low, closevolume,按时间从新到旧排列。价格和成交量均以十进制数字符串表示。

REST 和 MCP 目录覆盖 102 个已接受金融工具及已关闭的每日交易时段。日内柱线、股息和基本面不属于此版本。成功的 REST 和 MCP 调用消耗同一共享额度。

阅读方法与覆盖范围说明。该 运行时 OpenAPI 架构 定义确切的验证和错误响应。

报价流式传输 · Basic 与 Pro

连接到 wss://api.narwhalapi.com/v1/equities/stream 使用活动的 Basic 或 Pro Narwhal 密钥。服务器客户端发送 Authorization: Bearer YOUR_API_KEY 在WebSocket升级期间。该协议与REST和MCP分开。

支持的代码包括 ADSK, ALL, APD, ASML, EBAY, DOW, KMX, DVA,以美元报价。日频数据目录不代表这些数据均支持流式传输。

等待 ready 消息,然后将每条命令作为单独的 JSON 文本帧发送:

{"action":"subscribe","symbols":["ADSK","ALL"]}
{"action":"unsubscribe","symbols":["ALL"]}
{"action":"ping"}

报价包含 symbol, currency,十进制数字符串 price, source_timestamp, received_at, delivered_at, source_age_seconds, stalesnapshot。其类型为 quote. market_statusnot_evaluated;源数据年龄超过 60 秒时设置 stale=true.

每条获准报价消耗一个共享月度配额单位,包括缓存快照。账户速率和突发限制也同样适用。接收相同报价的两个连接会消耗两个单位。命令不计量;每个会话最多使用30条命令,文本帧不得超过2 KiB。

每个账户最多可同时打开两个连接。会话最长持续180秒;请使用退避策略重新连接并重新订阅。撤销的访问权限、不可用数据、配额耗尽或消费者速度过慢都会关闭连接。报价消耗配额后,传递仍可能失败。

浏览器连接当前仅接受 https://narwhalapi.com 源头。它们发送 {"action":"auth","api_key":"YOUR_API_KEY"} 在五秒内、订阅前完成。其他浏览器来源会被拒绝;请为集成使用服务器客户端。绝不要将密钥放入 URL 或发布在客户端代码中。

查看Basic和Pro计划读取数据流作用域和时间戳限制.