> For the complete documentation index, see [llms.txt](https://docs.infoway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infoway.io/websocket-api/subscribe-and-unsubscribe/depth-subscribe.md).

# 实时买卖盘口（Depth）订阅

### API说明

该WebSocket是获取买卖盘口的实时推送

### 请求频率

同一个WebSocket连接，所有的请求（订阅、取消订阅、心跳）限制为**1分钟60次**，如果超出请求频率限制将会自动断连。如果断连次数过多被系统判定为恶意请求将会封禁API Key。请在使用过程中注意调用逻辑。

### 错误码说明

参考[Websocket错误码说明](https://docs.infoway.io/getting-started/error-codes/websocket.md)

### 接口地址

请参考[Websocket订阅地址](https://docs.infoway.io/websocket-api/endpoints.md)

### 请求数量

不同的套餐对应的单Websocket订阅的产品数量不一样，具体参考[Websocket限制说明](https://docs.infoway.io/getting-started/api-limitation/websocket.md)

### 请求（协议号：10003）

```json
{
    "code": 10003,
    "trace": "423afec425004bd8a5e02e1ba5f9b2b0",
    "data": {
        "codes": "BTCUSDT"
    }
}
```

| 参数名     | 类型         | 必填 | 描述                                                | 示例值                                |
| ------- | ---------- | -- | ------------------------------------------------- | ---------------------------------- |
| `code`  | Integer    | 是  | 请求的协议号                                            | 盘口订阅协议号：`10003`                    |
| `trace` | String     | 是  | 可追溯ID（随机字符串）                                      | `423afec425004bd8a5e02e1ba5f9b2b0` |
| `data`  | JsonObject | 是  | 订阅数据                                              |                                    |
| `codes` | String     | 是  | 订阅产品，多个用逗号分隔；单连接及总数上限按套餐。印度 / 日本可写成 `BSE:INFY.IN` | `BTCUSDT`                          |

### 应答（协议号：10004）

```json
{
    "code": 10004,
    "trace": "423afec425004bd8a5e02e1ba5f9b2b0",
    "msg": "ok"
}
```

| 字段名     | 类型      | 必填 | 描述          | 示例值                                |
| ------- | ------- | -- | ----------- | ---------------------------------- |
| `code`  | Integer | 是  | 响应协议号       | 盘口响应协议号：`10004`                    |
| `trace` | String  | 是  | 订阅传入参数可追溯id | `423afec425004bd8a5e02e1ba5f9b2b0` |
| `msg`   | String  | 是  | 响应          | `ok`                               |

### 推送（协议号：10005）

```json
{
    "code": 10005,
    "data": {
        "a": [
            [
                "103594.12000000",
                "103594.13000000",
                "103594.38000000",
                "103594.39000000",
                "103594.40000000"
            ],
            [
                "3.50039000",
                "0.00016000",
                "0.00006000",
                "0.00006000",
                "0.00006000"
            ]
        ],
        "b": [
            [
                "103594.11000000",
                "103594.10000000",
                "103594.09000000",
                "103594.08000000",
                "103594.07000000"
            ],
            [
                "3.55117000",
                "0.05942000",
                "0.00006000",
                "0.00006000",
                "0.00006000"
            ]
        ],
        "s": "BTCUSDT",
        "t": 1747553102161
    }
}
```

<table><thead><tr><th width="97">字段名</th><th width="101">类型</th><th width="93">必填</th><th width="147">描述</th><th>示例值</th></tr></thead><tbody><tr><td><code>code</code></td><td>Integer</td><td>是</td><td>推送协议号</td><td>实时买卖盘口推送协议号：<code>10005</code></td></tr><tr><td><code>data</code></td><td>JSON</td><td>是</td><td>推送数据实体</td><td></td></tr><tr><td><code>s</code></td><td>String</td><td>是</td><td>标的名称</td><td><code>BTCUSDT</code></td></tr><tr><td><code>t</code></td><td>Long</td><td>是</td><td>盘口时间戳（毫秒）</td><td><code>1747552358393</code></td></tr><tr><td><code>a</code></td><td>JsonArray</td><td>是</td><td>卖盘，两个数组，分别是价格数组和挂单数量数组</td><td></td></tr><tr><td><code>a[0]</code></td><td>JsonArray</td><td>是</td><td>卖盘价格集合（通过下标跟同侧挂单数量对应）</td><td><code>["103594.12000000","103594.13000000" ,"103594.38000000","103594.39000000" ,"103594.40000000" ]</code></td></tr><tr><td><code>a[1]</code></td><td>JsonArray</td><td>是</td><td>卖盘挂单数量集合（通过下标跟同侧价格对应）</td><td><code>["3.50039000","0.00016000" ,"0.00006000","0.00006000" ,"0.00006000" ]</code></td></tr><tr><td><code>b</code></td><td>JsonArray</td><td>是</td><td>买盘，两个数组，分别是价格数组和挂单数量数组</td><td></td></tr><tr><td><code>b[0]</code></td><td>JsonArray</td><td>是</td><td>买盘价格集合（通过下标跟同侧挂单数量对应）</td><td><code>["103594.11000000","103594.10000000" ,"103594.09000000","103594.08000000" ,"103594.07000000" ]</code></td></tr><tr><td><code>b[1]</code></td><td>JsonArray</td><td>是</td><td>买盘挂单数量集合（通过下标跟同侧价格对应）</td><td><code>["3.55117000","0.05942000" ,"0.00006000","0.00006000" ,"0.00006000" ]</code></td></tr></tbody></table>

`a`、`b` 各包含两组字符串数组：第 `0` 组是价格，第 `1` 组是对应价格的挂单数量。例如一档盘口是 `[["100.25"],["3"]]`；多档按相同下标配对。盘口数量不是已经成交的数量。

订阅请求没有可选盘口档数参数。数字币源提供最多五档，实际推送频率和可用档数随市场及行情变化；订阅成功应答不保证立刻返回快照。

`business=india` / `business=japan` 把交易所写在 `codes` 前（印度 `NSE:INFY.IN`/`BSE:INFY.IN`，日本 `TSE:7203.JP`/`SAPSE:7203.JP`/`NAG:7203.JP`/`FSE:7203.JP`）。不写前缀则按产品名单解析到一个所，并退掉该代码在其他所的订阅。非法前缀返回 `506`，`msg` 为前缀本身；前缀或代码为空则为 `codes`。这一单里只要有一个代码带了前缀，推送 `data` 就会带 `ex`。要同时收多个所，请写多个带前缀的代码。规则见 [标的代码约定](https://docs.infoway.io/getting-started/biao-di-dai-ma-yue-ding.md)。 推送 `data.ex` 仅在这一单里有代码带了前缀时出现。
