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

# 订单簿

> 获取交易品种的实时盘口、实时订单簿深度（买卖盘）数据。

## 注意事项

* 买盘（bids）按价格降序排列
* 卖盘（asks）按价格升序排列
* 时间戳单位为毫秒（UTC）

## 支持的市场

**美股**、**港股**、**A股**、**中国期货**、**加密货币**

示例：

* 美股：AAPL.US、TSLA.US、MSFT.US
* 港股：700.HK、9988.HK、3690.HK
* A股：600519.SH、000001.SZ、920186.BJ
* 中国期货：BU2609、IC2606、AP8888
* 加密货币：BTCUSDT、ETHUSDT、ADAUSDT

## 请求参数

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

## 返回字段说明

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


## OpenAPI

````yaml GET /v1/market/depth
openapi: 3.0.0
info:
  title: TickDB API
  description: >-
    Unified real-time market data API — one connection for Forex, indices, US
    stocks, HK stocks, A-shares, China futures, and Crypto via REST and
    WebSocket.
  version: 1.0.2
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/market/depth:
    get:
      summary: Order Book
      description: Get real-time order book bids and asks
      parameters:
        - name: symbol
          in: query
          required: true
          description: Trading symbol
          schema:
            type: string
            default: 700.HK
            example: 700.HK
        - name: limit
          in: query
          required: false
          description: Depth levels (default 10, max 50)
          schema:
            type: integer
            minimum: 1
            maximum: 50
            example: 20
        - name: type
          in: query
          required: false
          description: >-
            Symbol type, optional. Not required when the symbol is unambiguous;
            if the API returns an AMBIGUOUS_SYMBOL error, pass the value as
            indicated
          schema:
            type: string
            enum:
              - stock
              - indices
              - crypto
              - forex
              - futures
            example: stock
      responses:
        '200':
          description: Successful response
          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: Buy orders sorted by price descending
                        items:
                          type: array
                          items:
                            type: string
                        example:
                          - - '626'
                            - '19700'
                          - - '625.5'
                            - '40800'
                      asks:
                        type: array
                        description: Sell orders sorted by price ascending
                        items:
                          type: array
                          items:
                            type: string
                        example:
                          - - '626.5'
                            - '36100'
                          - - '627'
                            - '50700'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````