Skip to main content
GET
Liquidation summary by market and window

Authorizations

Authorization
string
header
required

Ironflow API key, format if_xxxx. Free keys at https://ironflow.sh/key. Optional on read endpoints.

Query Parameters

market
string

One market or a comma list, up to 50. Omit for every market.

Example:

"BTC-PERP"

windows
string
default:1h

Comma list of 15m, 1h, 4h, 12h, 24h, 7d. Keyless calls reach 24h.

bucket
string

15m, 1h or 4h. Adds a long/short series per market over the longest window; needs market with 1 to 10 markets.

Response

Totals per window.

as_of
integer<int64>
windows
object[]
series
object

With bucket, per market, the long and short USD and count per step over the longest window.