> ## Documentation Index
> Fetch the complete documentation index at: https://alltick.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# WebSocket API 概要

> 本ページでは、AllTick株式WebSocket相場APIについて説明します。リアルタイム約定プッシュ、板深度プッシュ、購読と購読取消の方法、ハートビート機構、メッセージ形式の例を含みます。開発者がWebSocketストリーミングで米国株、香港株、A株などの市場のTickと注文板データに接続し、低遅延の相場システムを構築できるよう支援します。

AllTick WebSocket API は、リアルタイム相場プッシュを受信するために使用します。接続を確立した後、クライアントは購読リクエストを送信し、購読が成功すると、サーバーは最新約定価格と最新板情報データを継続的にプッシュします。接続中は、接続タイムアウトによる切断を避けるため、要件に従ってハートビートを送信する必要があります。

## 接続アドレス

| データタイプ                    | WebSocketアドレス                                                  |
| ------------------------- | -------------------------------------------------------------- |
| 米国株、香港株、A株、主要指数データ        | `wss://quote.alltick.co/quote-stock-b-ws-api?token=your_token` |
| 外国為替、貴金属、暗号資産、原油、CFD指数、商品 | `wss://quote.alltick.co/quote-b-ws-api?token=your_token`       |

接続を確立するたびに、URLへ認証tokenを付加する必要があります。接続成功後、必要に応じて最新約定価格または最新板情報の購読リクエストを送信します。

## インターフェース一覧

<CardGroup cols={2}>
  <Card title="最新約定価格（リアルタイムTickデータ、現在値、最新価格）一括購読" href="/ja/websocket/trade-subscription">
    商品の最新約定価格を購読します。購読成功後、プロトコル番号 22998 で約定データがプッシュされます。
  </Card>

  <Card title="最新板情報（リアルタイムTick単位深度、Order Book）購読" href="/ja/websocket/depth-subscription">
    商品の最新板深度を購読します。購読成功後、プロトコル番号 22999 で板情報データがプッシュされます。
  </Card>

  <Card title="ハートビート" href="/ja/websocket/heartbeat">
    10秒ごとにハートビートを送信します。30秒以内にハートビートリクエストを受信しない場合、WebSocket接続は切断されます。
  </Card>

  <Card title="相場購読の取消" href="/ja/websocket/cancel-subscription">
    すべての相場購読を取り消すか、タイプ別に板情報、約定、為替レートの購読を取り消します。
  </Card>

  <Card title="Kラインプッシュ（非対応）" href="/ja/websocket/kline-push-not-supported">
    WebSocketはKラインプッシュに対応していません。KラインはHTTPインターフェースでポーリングまたは一括照会できます。
  </Card>

  <Card title="WebSocket リクエスト例" href="/ja/websocket/websocket-request-example">
    Go、Java、PHP、Python のWebSocketリクエスト例を確認できます。
  </Card>
</CardGroup>

## プロトコル番号一覧

| プロトコル番号       | 説明                 |
| ------------- | ------------------ |
| 22004 / 22005 | 最新約定価格購読リクエスト / 応答 |
| 22998         | 最新約定価格プッシュ         |
| 22002 / 22003 | 最新板情報購読リクエスト / 応答  |
| 22999         | 最新板情報プッシュ          |
| 22000 / 22001 | ハートビートリクエスト / 応答   |
| 22006 / 22007 | 相場購読取消リクエスト / 応答   |

## 使用フロー

1. 商品タイプに応じて、株式または非株式のWebSocketアドレスを選択します。
2. 接続URLにtokenを付加し、WebSocket接続を確立します。
3. 最新約定価格または最新板情報の購読リクエストを送信します。
4. 接続を有効に保つため、10秒ごとにハートビートリクエストを送信します。
5. サーバーからプッシュされたデータを受信し、業務要件に応じて自動再接続を処理します。
6. プッシュが不要になった場合は、相場購読取消リクエストを送信します。

<Note>
  各WebSocket接続では、購読リクエストを送信するたびに、バックエンドはデフォルトで前回の購読リクエストを上書きします。商品を追加する場合は、完全な商品リストを再送信する必要があります。
</Note>

<script src="/seo-keywords.js" />