Liquidation summary
get_liquidation_summaryLiquidations on Hyperliquid over a trailing window, totalled across every market or the ones named: count, wallets, notional, longs vs shorts liquidated, the top markets and the largest single liquidation with its price. Use it for 'who got liquidated in the last hour?' or 'how much was liquidated today?'. For the individual liquidations use get_liquidations; for liquidation prices still ahead use get_liquidation_levels. Windows from 15m to 24h without a key, 7d with one. Totals are computed by the API over every liquidation, not sampled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| market | No | Optional: one market or a comma list (BTC-PERP,ETH-PERP); Hyperliquid names work (BTC, xyz:NVDA) | |
| window | No | Trailing window. Default 1h | |
| minutes | No | Older form of window, rounded up to the next one (90 becomes 4h) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Window end, Unix milliseconds | |
| from | No | Window start, Unix milliseconds | |
| count | No | Number of liquidations | |
| market | No | Market filter, or null for all markets | |
| notice | No | Present when the API added a note: how a market name was read, that data starts later than asked because of the history window, or a next step such as a free key | |
| window | No | Trailing window, e.g. 1h | |
| largest | No | Largest single liquidation, or null when there were none | |
| wallets | No | Distinct wallets liquidated | |
| complete | No | Always true: totals cover every liquidation in the window | |
| by_market | No | Top markets by liquidated notional | |
| notional_usd | No | Liquidated notional in USD | |
| longs_liquidated_usd | No | Notional of liquidated longs in USD | |
| shorts_liquidated_usd | No | Notional of liquidated shorts in USD |