> ## 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.

# 最新板情報（リアルタイムTick単位深度、Order Book）購読

> このインターフェースは、商品の最新板情報（リアルタイムTick単位深度、Order Book）データの購読に対応しています。履歴板情報データまたは履歴Tickデータには対応していません。

## インターフェース説明

このインターフェースは、商品の最新板情報（リアルタイムTick単位深度、Order Book）データの購読に対応しています。履歴板情報データまたは履歴Tickデータには対応していません。

インターフェース動作: 各WebSocket接続では、このリクエストを送信するたびに、バックエンドはデフォルトで前回の購読リクエストを上書きします。たとえば、最初に商品A、B、Cを購読しており、E、F、Gを追加したい場合は、A、B、C、E、F、Gをまとめて再送信する必要があります。購読が成功するとデータがプッシュされます。

注意事項:

1. 購読に一度成功した後は、頻繁に購読リクエストを再送信する必要はありません。10秒ごとにハートビートを送信する必要があり、インターフェースはリアルタイムでデータをプッシュします。30秒以内にハートビートリクエストを受信しない場合はタイムアウトとみなし、リクエスト元のWebSocket接続を切断します。

2. 接続時には、ネットワークなどの原因で切断された後に自動再接続できるよう、自動再接続ロジックを追加できます。

3. 各商品タイプで取得できる最大板深度は次のとおりです。

3.1 取引が活発でない商品では、取得できる深度が下表の最大段数より少ない場合があります。これは正常です。

3.2 板の片側が空になる場合があります。たとえば、株式がストップ高またはストップ安になった場合、板の片側が空になることがあります。

|      | 外国為替、貴金属、原油 | 暗号資産 | 香港株   | 米国株  | A株   |
| ---- | ----------- | ---- | ----- | ---- | ---- |
| 深度説明 | 最大1段        | 最大5段 | 最大10段 | 最大1段 | 最大5段 |

## インターフェース制限

1. 必ずお読みください: [WebSocketインターフェース制限](/ja/getting-started/websocket-interface-limitations)

2. 必ずお読みください: [エラーコード説明](/ja/getting-started/error-code-description)

## インターフェースURL

**1. 米国株、香港株、A株、主要指数データのインターフェースURL:**

* ベースパス: `/quote-stock-b-ws-api`
* 完全URL: `wss://quote.alltick.co/quote-stock-b-ws-api`

**2. 外国為替、貴金属、暗号資産、原油、CFD指数、商品のインターフェースURL:**

* ベースパス: `/quote-b-ws-api`
* 完全URL: `wss://quote.alltick.co/quote-b-ws-api`

## リクエスト例

**1. 米国株、香港株、A株、主要指数データのリクエスト例:**

接続を確立するたびに、認証tokenを次のようにURLへ付加する必要があります。

`wss://quote.alltick.co/quote-stock-b-ws-api?token=your_token`

接続成功後、必要に応じて具体的な株式市場データを購読できます。詳細な呼び出し方法は以下のドキュメントを参照してください。

**2. 外国為替、貴金属、暗号資産、原油、CFD指数、商品のリクエスト例:**

接続を確立するたびに、認証tokenを次のようにURLへ付加する必要があります。

`wss://quote.alltick.co/quote-b-ws-api?token=your_token`

接続成功後、必要に応じて具体的な外国為替、暗号資産、貴金属、商品データを購読できます。詳細な呼び出し方法は以下のドキュメントを参照してください。

## リクエスト - プロトコル番号: 22002

#### JSON定義

| フィールド        | 名称      | 型       | 必須 | 説明                                               |
| ------------ | ------- | ------- | -- | ------------------------------------------------ |
| cmd\_id      | プロトコル番号 | integer | はい | 最新板情報リクエストのプロトコル番号は固定で22002です。                   |
| seq\_id      | レスポンスID | integer | はい | 購読リクエスト識別子。レスポンスで返却されます。任意値で、リクエストごとに重複しても構いません。 |
| trace        | 追跡ID    | string  | はい | リクエストログ情報用の追跡ID。任意値で、リクエストごとに重複させないでください。        |
| symbol\_list | 商品リスト   | array   | はい | 具体的な形式は下記のsymbol定義を参照してください。                     |

#### Symbol定義

| フィールド        | 名称   | 型      | 必須  | 説明                                                                                                                                                                                                           |
| ------------ | ---- | ------ | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| code         | コード  | string | はい  | 詳細はcodeリストを参照してください: [codeリストを開く](https://docs.google.com/spreadsheets/d/1avkeR1heZSj6gXIkDeBt8X3nv4EzJetw4yFuKjSDYtA/edit?gid=495387863#gid=495387863)<br />**注意: code値の大文字・小文字は商品リスト内のcodeと一致させる必要があります。** |
| depth\_level | 深度段数 | uint32 | いいえ | depth\_levelフィールドを指定しない場合、バックエンドは1段の相場のみ提供します。要求段数が実際の相場深度より大きい場合、またはdepth\_levelを指定しない場合、バックエンドは実際に存在する段数分を返します。                                                                                            |

### データ構造（JSON）

```json theme={null}
{
  "cmd_id": 22002,
  "seq_id": 123,
  "trace": "3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
  "data": {
    "symbol_list": [
      {
        "code": "BTCUSDT",
        "depth_level": 5
      },
      {
        "code": "ETHUSDT",
        "depth_level": 5
      }
    ]
  }
}
```

## レスポンス - プロトコル番号: 22003

### データ構造（JSON）

```json theme={null}
{
  "ret": 200,
  "msg": "ok",
  "cmd_id": 22003,
  "seq_id": 123,
  "trace": "3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
  "data": {}
}
```

## プッシュ - プロトコル番号: 22999

#### データ定義

| フィールド      | 名称        | 型       | 説明                                                                                                                                                      |
| ---------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code       | コード       | string  | 詳細はcodeリストを参照してください: [codeリストを開く](https://docs.google.com/spreadsheets/d/1avkeR1heZSj6gXIkDeBt8X3nv4EzJetw4yFuKjSDYtA/edit?gid=495387863#gid=495387863) |
| seq        | 相場シーケンス番号 | integer |                                                                                                                                                         |
| tick\_time | 相場タイムスタンプ | integer | 単位: ミリ秒                                                                                                                                                 |
| bids       | 買い板深度     | string  | 下記のbids定義を参照してください。                                                                                                                                     |
| asks       | 売り板深度     | string  | 下記のasks定義を参照してください。                                                                                                                                     |

#### Bids定義

| フィールド  | 名称            | 型      | 説明                                                                  |
| ------ | ------------- | ------ | ------------------------------------------------------------------- |
| price  | 最良買気配価格、買い側価格 | string |                                                                     |
| volume | 最良買気配数量、買い側数量 | string | 1. 一部のCFD指数は数量を提供しません。<br />2. 外国為替、貴金属、エネルギー、株式、暗号資産はいずれも数量を提供します。 |

#### Asks定義

| フィールド  | 名称            | 型      | 説明                                                                  |
| ------ | ------------- | ------ | ------------------------------------------------------------------- |
| price  | 最良売気配価格、売り側価格 | string |                                                                     |
| volume | 最良売気配数量、売り側数量 | string | 1. 一部のCFD指数は数量を提供しません。<br />2. 外国為替、貴金属、エネルギー、株式、暗号資産はいずれも数量を提供します。 |

### データ構造（JSON）

```json theme={null}
{
  "cmd_id": 22999,
  "data": {
    "code": "HK-1288",
    "seq": 1605509068000001,
    "tick_time": 1605509068,
    "bids": [
      {
        "price": "9.12",
        "volume": "9.12"
      }
    ],
    "asks": [
      {
        "price": "147.12",
        "volume": "147.12"
      }
    ]
  }
}
```

#### AllTickウェブサイト

<Note>
  公式サイト: <a href="https://alltick.co/">[https://alltick.co/](https://alltick.co/)</a>
</Note>

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