liquidation_heatmap
Aggregated long/short liquidation USD by (token, exchange) over a rolling window. Identifies which tokens and venues are seeing the most liquidation activity. Result cached for ~10s.
Usage hints:
- Windows: 1h, 4h, 24h (sub-1h not supported — use WS feed for finer granularity)
- topN controls how many entries to return (default 10)
- Useful for spotting tokens experiencing forced unwinds
REST endpoint
GET /api/v1/liquidation/heatmap — see REST reference.
Parameters
| Name | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
window | string | no | 1h | Rolling window (1h, 4h, 24h) (default: 1h) | "1h" |
topN | integer | no | 10 | Top N tokens by total (default: 10) | 10 |
Example invocation
JSON-RPC tools/call payload:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "liquidation_heatmap",
"arguments": {
"window": "1h",
"topN": 10
}
}
}