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

# 盘口深度

> 获取交易品种的实时买卖盘口数据。

## 套餐权限

| 套餐 | 可用 |
| - | :-: |
| 免费版 | ❌ |
| 基础版 | ✅ |
| 专业版 | ✅ |
| 全量套餐（A 股、港股、美股） | ✅ |
| 企业版 | ✅ |

## 注意事项

* 买盘（bids）按价格降序排列
* 卖盘（asks）按价格升序排列
* 返回档位数量由相应市场实际支持的深度决定
* 时间戳单位为毫秒（UTC）

## 支持的市场

| 市场 | 示例 | 每侧盘口档位 |
| - | - | - |
| 美股 | AAPL.US、TSLA.US、MSFT.US | 1档 |
| 港股 | 700.HK、9988.HK、3690.HK | 10档 |
| A股 | 600519.SH、000001.SZ、920186.BJ | 5档 |
| 中国期货 | BU2609、RB8888、AP8888 | 1档 |
| 香港期货 | HSI8888、MHI8888、HTI8888 | 10档 |
| 加密货币 | BTCUSDT、ETHUSDT、ADAUSDT、OKBUSDT | 最高1000档 |

表中为每侧盘口最高支持档位。不同产品支持的深度可能不同；休市、流动性不足或部分档位无报价时，实际返回档位可能少于表中数量。

## 请求参数

| 参数名 | 是否必须 | 描述 |
| - | - | - |
| symbol | 是 | 交易产品代码 |
| type | 否 | 产品类型，可选。代码无歧义时无需传递；若返回 `AMBIGUOUS_SYMBOL` 错误，按提示传入对应值即可。可选值：`stock`、`indices`、`crypto`、`forex`、`futures` |

## 返回字段说明

| 字段 | 说明 |
| - | - |
| symbol | 交易产品 |
| type | 产品类型 |
| timestamp | 数据时间戳（毫秒，UTC） |
| bids | 买盘数组，每个元素为 \[价格, 数量] |
| asks | 卖盘数组，每个元素为 \[价格, 数量] |


## OpenAPI

````yaml openapi.yaml GET /v1/market/depth
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB 统一实时行情数据 API，提供 REST 和 WebSocket 接入。
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: 生产环境
security:
  - ApiKeyAuth: []
paths:
  /v1/market/depth:
    get:
      summary: 盘口深度
      description: 获取交易品种的实时买卖盘口数据。
      parameters:
        - name: symbol
          in: query
          required: true
          description: 交易产品代码
          schema:
            type: string
            default: 700.HK
            example: 700.HK
        - name: type
          in: query
          required: false
          description: >-
            产品类型，可选。代码无歧义时无需传递；若返回 `AMBIGUOUS_SYMBOL`
            错误，按提示传入对应值即可。可选值：`stock`、`indices`、`crypto`、`forex`、`futures`
          schema:
            type: string
            enum:
              - stock
              - indices
              - crypto
              - forex
              - futures
            example: stock
      responses:
        '200':
          description: 请求成功。
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 0
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      symbol:
                        type: string
                        example: 700.HK
                      type:
                        type: string
                        enum:
                          - stock
                          - indices
                          - crypto
                          - forex
                          - futures
                      timestamp:
                        type: integer
                        example: 1768274016162
                      bids:
                        type: array
                        description: 买盘数组，每个元素为 [价格, 数量]
                        items:
                          type: array
                          items:
                            type: string
                        example:
                          - - '626'
                            - '19700'
                          - - '625.5'
                            - '40800'
                      asks:
                        type: array
                        description: 卖盘数组，每个元素为 [价格, 数量]
                        items:
                          type: array
                          items:
                            type: string
                        example:
                          - - '626.5'
                            - '36100'
                          - - '627'
                            - '50700'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.