API Reference

Large Orderbook

The API retrieves large order data from the order book for futures trading.

# Required Account Level: Standard Edition and Above

Response Data

{
  "code": "0",
  "msg": "success",
  "data": [
    {
      "exName": "Binance",
      "symbol": "BTCUSDT",
      "baseAsset": "BTC",
      "quoteAsset": "USDT",
      "price": 56932,
      "startTime": 1722964242000,
      "startAmount": 28.39774,
      "startUsd": 1616740.1337,
      "currentAmount": 18.77405,
      "currentUsd": 1068844.21,
      "currentTime": 1722964272000,
      "vol": 0,
      "volUsd": 0,
      "count": 0,
      "side": 2,
      "state": 1,
      "endTime": 1722964291000
    }]
}

FieldDescription
exNameExchange name, e.g., Binance
symbolTrading pair, e.g., BTCUSDT
baseAssetBase asset, e.g., BTC
quoteAssete.g., USDT
pricePrice, e.g., 56932
startTimeStart time, in milliseconds, e.g., 1722964242000
startAmountInitial order size, e.g., 28.39774
startUsdInitial order value, e.g., 1616740.1337
currentAmountCurrent order amount, e.g., 18.77405
currentUsdCurrent order value in USD, e.g., 1068844.21
currentTimeCurrent time, in milliseconds, e.g., 1722964272000
volTrading volume, e.g., 1000
volUsdTrading volume in USD, e.g., 1000000
countNumber of trades, e.g., 10
sideTrade direction, e.g., 2 (1-Buy/2-Sell)
stateTrade status, e.g., 1 (1-In Progress/2-Completed)
endTimeEnd time, in milliseconds, e.g., 1722964291000
Language
Credentials
Header
Click Try It! to start a request and see the response here!