Discovery and markets API

Spot large orders brief: the biggest walls in a spot book

The 10 largest resting bid and ask walls of a coin's spot pair on one exchange, the rest's total, and the newest to leave.

GET/api/external/discovery/spot-large-orders-brief/{symbol}

What it returns

The brief of spot-large-orders; prefer it unless you need every wall. The same coin, exchange, quote and limit. It lists the 10 largest resting bids and the 10 largest resting asks by value, highest price first, with how many other orders rest and their summed value, and the 10 orders that left the book most recently, each exactly as spot-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/discovery/spot-large-orders-brief/<symbol>?venue=Binance"
Parameters
ParameterDescription
venue

query · string · required

The exchange, spelled exactly as listed (case-sensitive), as spot-coin-venues names it.BinanceBitfinexBybitCoinbaseKrakenOKX
quote

query · string · optional

The quote currency of the pair, e.g. "USDT" or "USD". Case-insensitive. Optional: without it, USDT, then USD, then USDC.
limit

query · 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.
symbol

path · string · required

The coin (base asset) ticker, e.g. "BTC" or "SOL" — not a pair such as "BTCUSDT" or "BTC/USDT", and not a token mint or contract address. Case-insensitive.

Response fields

A JSON response. Every field is always present; null means the value could not be established, never zero.

Response fields of Spot large orders brief: the biggest walls in a spot book
FieldTypeDescription
symbolstringThe coin ticker as the exchange lists it, e.g. "BTC" for "btc".
venuestringThe exchange.
quotestringThe currency every price and value is in, e.g. "USDT" or "USD".
pairstringThe pair, BASE/QUOTE, as spot-coin-venues prints it.
staleOmittedintegerResting orders left out because an opposite order updated later crossed their price, so they had already gone.
restingCountintegerOrders resting now in the full answer.
bidCountintegerOf them, bids.
askCountintegerOf them, asks.
restingobject[]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[].idstringAn id for the order, stable across reads.
resting[].sidestringbid: an order to buy; ask: an order to sell.
resting[].pricenumberThe limit price, in quote.
resting[].openedAtnumber | nullWhen the order was first seen in the book, unix seconds. null when not stated.
resting[].updatedAtnumberWhen the order was last updated, unix seconds. An order that has not changed keeps an old time.
resting[].endedAtnumber | nullWhen the order left the book, unix seconds. null while it rests.
resting[].initialQuantitynumber | nullThe quantity when first seen, in units of the coin. null when not stated.
resting[].initialValuenumber | nullinitialQuantity times price, in quote. null when not stated.
resting[].quantitynumber | nullThe quantity at the last update, in units of the coin. It can exceed initialQuantity when the order grew. null when not stated.
resting[].valuenumber | nullquantity times price, in quote. null when not stated.
resting[].filledQuantitynumber | nullHow much of it traded, in units of the coin. null when not stated.
resting[].filledValuenumber | nullThe traded part times price, in quote. null when not stated.
resting[].tradesnumber | nullHow many trades filled part of it. null when not stated.
resting[].statusstringresting: still in the book; filled: left the book having traded some or all of it; pulled: left without trading.
restingCutCountintegerResting orders of the full answer not listed in resting.
restingCutValuenumber | nullThe summed value of those orders, in quote. An order whose value is not stated is counted but not summed. 0 when none was left out; null when none of them states one.
endedCountintegerOrders that left the book in the full answer, at most its limit.
endedobject[]The 10 orders that left the book most recently, newest first.
ended[].idstringAn id for the order, stable across reads.
ended[].sidestringbid: an order to buy; ask: an order to sell.
ended[].pricenumberThe limit price, in quote.
ended[].openedAtnumber | nullWhen the order was first seen in the book, unix seconds. null when not stated.
ended[].updatedAtnumberWhen the order was last updated, unix seconds. An order that has not changed keeps an old time.
ended[].endedAtnumber | nullWhen the order left the book, unix seconds. null while it rests.
ended[].initialQuantitynumber | nullThe quantity when first seen, in units of the coin. null when not stated.
ended[].initialValuenumber | nullinitialQuantity times price, in quote. null when not stated.
ended[].quantitynumber | nullThe quantity at the last update, in units of the coin. It can exceed initialQuantity when the order grew. null when not stated.
ended[].valuenumber | nullquantity times price, in quote. null when not stated.
ended[].filledQuantitynumber | nullHow much of it traded, in units of the coin. null when not stated.
ended[].filledValuenumber | nullThe traded part times price, in quote. null when not stated.
ended[].tradesnumber | nullHow many trades filled part of it. null when not stated.
ended[].statusstringresting: 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