Skip to main content

Order Book Information

Provides order book data queries for futures trading pairs, supporting price precision aggregation and depth level limits.


Get Order Book Information

Get order book data for a specified futures trading pair, with support for price precision aggregation and depth level limits.

API Information

  • Method: GET
  • Path: /fapi/v1/depth

Request Parameters

ParameterLocationTypeRequiredDescription
symbolquerystringYesTrading pair, e.g. BTC_USDT
precisionqueryintegerNoPrice precision (decimal places). If omitted, original precision is returned
limitqueryintegerNoDepth level limit, default 100, max 5000
with_idquerybooleanNoWhether to return the sequence ID

Request Example

GET /fapi/v1/depth?symbol=BTC_USDT&limit=100&with_id=true

Response Fields

FieldTypeDescription
codeintegerError code, 0 indicates success
messagestringError message
dataobjectOrder book data
data.symbolstringTrading pair
data.asksarrayAsk levels in the format [[price, qty], ...]
data.bidsarrayBid levels in the format [[price, qty], ...]
data.idintegerSequence ID (returned when with_id=true)
data.timestampintegerTimestamp (milliseconds)

Response Example

{
"code": 0,
"message": "success",
"data": {
"symbol": "BTC_USDT",
"asks": [
["42166.00", "0.125"],
["42167.00", "0.250"]
],
"bids": [
["42165.00", "0.310"],
["42164.00", "0.500"]
],
"id": 12345,
"timestamp": 1768051394008
}
}

Error Response

HTTP StatuscodeDescription
4004000Invalid parameter, such as symbol is required
503-Service unavailable
{
"code": 4000,
"data": null,
"message": "symbol is required"
}

Get Synchronization Status

Get the order book synchronization status of all futures trading pairs.

API Information

  • Method: GET
  • Path: /fapi/v1/depth/status

Request Parameters

None

Request Example

GET /fapi/v1/depth/status

Response Fields

FieldTypeDescription
codeintegerError code, 0 indicates success
messagestringError message
dataobjectSynchronization status data
data.symbolsobjectTrading pair synchronization status map (key=trading pair, value=status string)

Response Example

{
"code": 0,
"message": "success",
"data": {
"symbols": {
"BTC_USDT": "synced",
"ETH_USDT": "syncing"
}
}
}