Perpetuals API
Derivatives large orders brief: the biggest walls in a perp book
The 10 largest resting bid and ask walls of a perpetual or future on one exchange, and the newest to leave.
GET
/api/external/perps/derivatives-large-orders-brief/{symbol}What it returns
The brief of derivatives-large-orders; prefer it unless you need every wall. The same instrument, venue and limit. It lists the 10 largest resting bids and the 10 largest resting asks by value, highest price first, and the 10 orders that left the book most recently, each exactly as derivatives-large-orders lists it, with how many orders rest on each side and how many ended.
Chains
This endpoint is not tied to a chain: it takes no chain in its request.
Request
Send your key in the x-dex-data-key header. Replace each <placeholder> with a real value.
curl -H "x-dex-data-key: $DEXDATA_API_KEY" \ "https://api.dexdata.io/api/external/perps/derivatives-large-orders-brief/<symbol>?venue=Binance"
| Parameter | Description |
|---|---|
venuequery · string · required | The exchange, spelled exactly as listed (case-sensitive), as derivatives-coin-venues names it.BinanceBitgetBybitGateOKX |
limitquery · integer · optional | How many of the orders that left the book most recently to return, 1 to 200. Defaults to 50. Does not limit the resting orders. |
symbolpath · string · required | The venue's own instrument id, as instrument in derivatives-coin-venues rows: e.g. "BTCUSDT" (Binance, Bybit), "BTC-USDT-SWAP" (OKX), "BTC_USDT" (Gate), "BTCUSDT_UMCBL" (Bitget) — not a bare coin ticker such as "BTC", and not a token mint or contract address. The exact spelling is matched first; otherwise the one listed id that differs only in case. |
Response fields
A JSON response. Every field is always present; null means the value could not be established, never zero.
| Field | Type | Description |
|---|---|---|
instrument | string | The instrument id as the exchange lists it, e.g. "BTCUSDT" for "btcusdt". |
venue | string | The exchange. |
symbol | string | The coin (base asset) ticker, as the exchange lists it. |
quote | string | The currency every price and value is in, e.g. "USDT" or "USD". |
staleOmitted | integer | Resting orders left out because an opposite order updated later crossed their price, so they had already gone. |
restingCount | integer | Orders resting now in the full answer. |
bidCount | integer | Of them, bids. |
askCount | integer | Of them, asks. |
resting | object[] | The 10 largest resting bids and asks by value, highest price first; an order whose value is not stated ranks after every stated one. |
resting[].id | string | An id for the order, stable across reads. |
resting[].side | string | bid: an order to buy; ask: an order to sell. |
resting[].price | number | The limit price, in quote. |
resting[].openedAt | number | null | When the order was first seen in the book, unix seconds. null when not stated. |
resting[].updatedAt | number | When the order was last updated, unix seconds. An order that has not changed keeps an old time. |
resting[].endedAt | number | null | When the order left the book, unix seconds. null while it rests. |
resting[].initialQuantity | number | null | The quantity when first seen, in units of the coin. null when not stated. |
resting[].initialValue | number | null | initialQuantity times price, in quote. null when not stated. |
resting[].quantity | number | null | The quantity at the last update, in units of the coin. It can exceed initialQuantity when the order grew. null when not stated. |
resting[].value | number | null | quantity times price, in quote. null when not stated. |
resting[].filledQuantity | number | null | How much of it traded, in units of the coin. null when not stated. |
resting[].filledValue | number | null | The traded part times price, in quote. null when not stated. |
resting[].trades | number | null | How many trades filled part of it. null when not stated. |
resting[].status | string | resting: still in the book; filled: left the book having traded some or all of it; pulled: left without trading. |
endedCount | integer | Orders that left the book in the full answer, at most its limit. |
ended | object[] | The 10 orders that left the book most recently, newest first. |
ended[].id | string | An id for the order, stable across reads. |
ended[].side | string | bid: an order to buy; ask: an order to sell. |
ended[].price | number | The limit price, in quote. |
ended[].openedAt | number | null | When the order was first seen in the book, unix seconds. null when not stated. |
ended[].updatedAt | number | When the order was last updated, unix seconds. An order that has not changed keeps an old time. |
ended[].endedAt | number | null | When the order left the book, unix seconds. null while it rests. |
ended[].initialQuantity | number | null | The quantity when first seen, in units of the coin. null when not stated. |
ended[].initialValue | number | null | initialQuantity times price, in quote. null when not stated. |
ended[].quantity | number | null | The quantity at the last update, in units of the coin. It can exceed initialQuantity when the order grew. null when not stated. |
ended[].value | number | null | quantity times price, in quote. null when not stated. |
ended[].filledQuantity | number | null | How much of it traded, in units of the coin. null when not stated. |
ended[].filledValue | number | null | The traded part times price, in quote. null when not stated. |
ended[].trades | number | null | How many trades filled part of it. null when not stated. |
ended[].status | string | resting: still in the book; filled: left the book having traded some or all of it; pulled: left without trading. |
Start building with DexData today
Sign in, create a key and make your first call in a minute. Free credits every month, and you only pay for calls that succeed.
Get a free API key