瀏覽全部文件

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排程讀取數據流作用域和時間戳記限制.