WebSocket 共通標準ヘッダー

本ページでは、AllTick WebSocket相場APIで使用する共通標準メッセージヘッダーと接続パラメータについて詳しく説明します。認証関連フィールド、プロトコルバージョン、圧縮などの情報を含み、開発者がリアルタイム相場購読接続を確立する際に、統一仕様に従ってヘッダーとハンドシェイクパラメータを送信し、プッシュデータの安全性と互換性を確保できるよう支援します。

​

リクエスト共通標準ヘッダー紹介

フィールド	名称	型	必須	説明
cmd_id	プロトコル番号	uint32	各インターフェース定義を参照
seq_id	シーケンス番号	uint32	はい	リクエスト側が一意に生成します。レスポンスはリクエストと同じ値を保持します。
trace	トレース番号	string	はい	リクエスト側が一意に生成します。レスポンスはリクエストと同じ値を保持します。最大長は 64 です。
data	データ本体	object	はい	具体的なデータ形式は各インターフェース定義を参照してください。

{
  "cmd_id": 22000,
  "seq_id": 123,
  "trace": "asdfsdfa",
  "data": {}
}

​

レスポンス共通標準ヘッダー紹介

フィールド	名称	型	説明
ret	戻り値	int32	エラーコード説明
msg	メッセージ	string	成功または失敗の具体的な説明。
cmd_id	プロトコル番号	uint32	各インターフェース定義を参照してください。
seq_id	シーケンス番号	uint32	リクエスト側が一意に生成します。レスポンスはリクエストと同じ値を保持します。
trace	トレース番号	string	リクエスト側が一意に生成します。レスポンスはリクエストと同じ値を保持します。最大長は 64 です。
data	データ本体	object	具体的なデータ形式は各インターフェース定義を参照してください。

{
  "ret": 201,
  "msg": "request header param invalid",
  "cmd_id": 0,
  "seq_id": 0,
  "trace": "",
  "data": {}
}

---

​

AllTick 公式サイト

公式サイト：https://alltick.co/