Skip to main content
POST
crypto.liquidations.large-orders

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
exchange
string

Exchange name. Can be Binance, OKX, Bybit, Bitget, Hyperliquid, Gate, HTX, Bitmex, Bitfinex, CoinEx, Aster, or Lighter. Example: Binance. Defaults to "Binance". One of: Binance, OKX, Bybit, Bitget, Hy.

Required string length: 1 - 512
from
string

Start of time range (inclusive). Accepts Unix seconds (1704067200) or date string (2024-01-01). Example: 2024-01-01.

Required string length: 1 - 512
limit
number

How many to return, 1 to 20. Default 10.

Required range: x >= 1
minAmount
string

Minimum liquidation amount in USD. Example: 10000. Defaults to "10000".

Required string length: 1 - 512
order
enum<string>

Sort order. Defaults to "desc".

Available options:
asc,
desc
side
enum<string>

Filter by liquidation side. Omit to return both. Example: long.

Available options:
long,
short
sortBy
enum<string>

Field to sort results by. Defaults to "timestamp".

Available options:
usd_value,
timestamp,
price
symbol
string

Token ticker symbol like BTC or ETH. Example: BTC. Defaults to "BTC".

Required string length: 1 - 512
to
string

End of time range, exclusive (returns rows strictly older than to). Accepts Unix seconds (1706745600) or date string (2024-02-01). To page backward, set this to the oldest returned timestamp + 1 and d.

Required string length: 1 - 512

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.