Liquidation cluster map
hl_liquidation_map[PREMIUM — needs an API key: call hl_request_free_key first for a free key, or pay per call via x402] Estimated liquidation clusters for a coin from a whale cohort's open positions: distribution of liquidation prices and notional-at-risk bucketed by % distance from mark, plus nearest downside/upside cascade levels. Estimate over the cohort only (not exchange-wide). Analytics only, not investment advice.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"coin": "<coin>"
},
"name": "hl_liquidation_map"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | Perp coin symbol. | |
| topN | No | ||
| cohort | No | ||
| bucketPct | No | Bucket width as % of mark price. | |
| maxDistancePct | No | Ignore liq prices beyond this % from mark. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | ||
| markPx | Yes | ||
| buckets | Yes | ||
| disclaimer | Yes | ||
| walletsQueried | Yes | ||
| positionsConsidered | Yes | ||
| nearestUpsideCluster | Yes | ||
| nearestDownsideCluster | Yes | ||
| totalNotionalAtRiskUsd | Yes |