Skip to main content
Version: Next

Order Book Depth

Get the buy/sell order book depth data for a specified trading pair.

Interface Information

  • Method: GET
  • Path: /api/v1/stock/open-api/depth

Request Parameters

ParameterTypeRequiredDescription
symbolstringYesTrading pair, e.g., XSM
limitintNoNumber of levels to return, default 20, max 400

Request Example

GET /api/v1/stock/open-api/depth?symbol=XSM&limit=20

Response Fields

FieldTypeDescription
codeintStatus code
msgstringStatus message
data.symbolstringTrading pair
data.bidsarrayBids, [[price, quantity], ...]
data.asksarrayAsks, [[price, quantity], ...]
data.timestampint64Timestamp
Note
  • bids are sorted from highest to lowest price
  • asks are sorted from lowest to highest price

Response Example

{
"code": 0,
"msg": "success",
"data": {
"symbol": "XSM",
"bids": [
["185.50", "1000"],
["185.40", "500"]
],
"asks": [
["185.60", "800"],
["185.70", "1200"]
],
"timestamp": 1705737600000
}
}