すべてのドキュメントを閲覧

Equities APIリファレンス

RESTおよびMCPによる日次データと、8銘柄の米ドル株式向け有料WebSocketストリーム。

操作一覧

送信 Authorization: Bearer YOUR_API_KEY 宛先: https://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_code および country、さらに page (デフォルトは1)および outputsize (デフォルトは100、最大5,000)。

バーには次が必要です instrument_id。対応する値は interval=1day および adjust=splits。任意 start_date および end_date YYYY-MM-DD を使用します。 outputsize デフォルトは30で、最大5,000です。

レスポンスと上限

ディスカバリーと詳細のレスポンス count, data および status。各銘柄にはID、シンボル、名前、通貨、取引所、MIC、国、普通株式の種類が含まれます。

バーは次を返します meta, values および status。メタデータには通貨、取引所のタイムゾーン、MICが含まれます。値には datetime, open, high, low, close および volume、新しい順に並びます。価格と出来高は小数文字列です。

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, stale および snapshot。種類は quote. market_status 次のもの: not_evaluated。ソースの経過時間が60秒を超えると stale=true.

受け入れられた各気配値は、キャッシュされたスナップショットを含め、共有月間クォータを1単位消費します。アカウントのレート制限とバースト制限も適用されます。同じ気配値を受け取る2接続は2単位を消費します。コマンドは計測対象外です。1セッションあたり最大30コマンド、テキストフレームは2 KiB以下にしてください。

各アカウントは同時に2接続まで開けます。セッションは最長180秒です。バックオフして再接続し、再購読してください。アクセス取消し、データ利用不能、クォータ枯渇、低速コンシューマーにより接続が閉じられます。気配値がクォータを消費した後に配信が失敗する場合があります。

現在、ブラウザ接続が受け付けるのは https://narwhalapi.com オリジン。これらは送信します: {"action":"auth","api_key":"YOUR_API_KEY"} サブスクライブする前の5秒以内に指定します。その他のブラウザーオリジンは拒否されます。統合にはサーバークライアントを使用してください。キーをURLに入れたりクライアントコードで公開したりしないでください。

Basic と Pro のプランを表示 または ストリーミングの範囲とタイムスタンプ上限を読む.