Liquidation Aggregates
DevGET /liquidations/aggregates
Aggregated liquidation totals and per-group breakdowns over a rolling time window. Returns total long/short liquidated USD, event counts, and a ranked list of the biggest contributors. Use it to gauge overall market stress, compare which exchanges or symbols are seeing the most forced liquidations, or feed a summary dashboard.
Authentication
Requires Dev tier or higher. Free tier does not have access (returns 403).
Parameters
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
period | string | – | 1h, 4h, 12h, or 24h. Defaults to 24h. |
group_by | string | – | symbol, exchange, or symbol_exchange. Defaults to symbol. |
exchange | string | – | Comma-separated exchange filter. |
symbol | string | – | Comma-separated symbol filter. |
exclude_symbol | string | – | Comma-separated symbols to exclude. |
Example request
bash
curl -H "X-Api-Key: lk_live_your_key_here" \
"https://api.loris.tools/liquidations/aggregates?period=24h&group_by=symbol"Example response
json
{
"period": "24h",
"group_by": "symbol",
"totals": {
"long_count": 18420,
"short_count": 9310,
"long_usd": 423000000,
"short_usd": 198000000,
"total_count": 27730,
"total_usd": 621000000
},
"groups": [
{
"name": "BTC",
"long_count": 4200,
"short_count": 2100,
"long_usd": 145000000,
"short_usd": 62000000,
"total_count": 6300,
"total_usd": 207000000
},
{
"name": "ETH",
"long_count": 3800,
"short_count": 1900,
"long_usd": 98000000,
"short_usd": 41000000,
"total_count": 5700,
"total_usd": 139000000
}
],
"largest": {
"name": "BTC",
"total_usd": 207000000
}
}Errors
400— Invalid period value. Accepted: 1h, 4h, 12h, 24h.
For authentication errors (401) and rate limit responses (429), see Errors.