Skip to main content
POST
crypto.liquidations.by-exchange

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
order
enum<string>

Sort order. Example: desc. Defaults to "desc".

Available options:
asc,
desc
sortBy
enum<string>

Field to sort results by. Example: liquidation_usd. Defaults to "liquidation_usd".

Available options:
liquidation_usd,
long_liquidation_usd,
short_liquidation_usd
symbol
string

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

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

Window to aggregate over for the snapshot: 1h, 4h, 12h, or 24h. Returns a single snapshot (not a time-series). This endpoint uses time_range only — it does NOT accept interval. Example: 24h. Defaults .

Available options:
1h,
4h,
12h,
24h

Response

The result

results
object[]
required

The matching items.

nextCursor
string

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