共通メッセージ · WebSocket

接続・認証・購読制限は WebSocket 概要を参照してください。

購読解除

購読の確認 (type: subscribed)

RECEIVEsubscribed

サーバー → クライアント

受理した購読 ID を返します。リクエストの ID が未指定または空の場合は default です。

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	許容値: "subscribed"
subscription_id	string	はい	リクエストの購読 ID。省略または空の場合は default。

例

{
  "type": "subscribed",
  "subscription_id": "btc-jpy"
}

アプリケーションのハートビート (type: ping)

SENDping

クライアント → サーバー

アプリケーションのハートビートは pong で ts をそのまま返します。WebSocket プロトコルの ping/pong フレームとは別です。サーバーは 30 秒ごとにプロトコル ping を送信し、90 秒の読み取り期限内にプロトコル pong を受け取る必要があります。ブラウザーは自動で処理します。

応答: pong

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	ping 固定。 許容値: "ping"
ts	string	いいえ	pong にそのまま返す文字列。既定値は空文字列。 既定値: ""

例

{
  "type": "ping",
  "ts": "1787974923000"
}

ハートビート応答 (type: pong)

RECEIVEpong

サーバー → クライアント

アプリケーション ping の ts をそのまま返します。WebSocket プロトコルの pong フレームとは別です。

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	許容値: "pong"
ts	string	はい

例

{
  "type": "pong",
  "ts": "1787974923000"
}

エラー (type: error)

RECEIVEerror

サーバー → クライアント

購読の検証エラーでは既存の購読と接続が維持されます。subscribe_failed の後は切断されます。不正な JSON や 64 KiB を超えるメッセージでは、JSON エラーを返さず切断される場合があります。

code	説明
invalid_subscription	quote、チャネル、シンボル、間隔が無効。
subscription_limit	接続の購読数が 100 件を超えます。
symbol_limit	シンボル数の上限超過、または全アセット購読の競合。
unknown_message	未対応のメッセージ種別。
subscribe_failed	リアルタイム配信が利用不可。待機時間を増やして再接続してください。

メッセージのフィールド

フィールド	型	必須	説明
type	string	はい	error 固定。 許容値: "error"
code	string	はい	機械処理用コード。上記のエラーコードを参照してください。 許容値: "invalid_subscription", "subscription_limit", "symbol_limit", "unknown_message", "subscribe_failed"
message	string	はい	エラーの説明。

例

{
  "type": "error",
  "code": "symbol_limit",
  "message": "a quote-only market subscription uses the full symbol budget; use a separate connection"
}