Recorded liquidations for one coin
coin_liquidationsRead-onlyIdempotent
Forced closes ALREADY recorded for one pair, split long versus short. These are executed liquidations, not projected levels: for where liquidations could happen next use liq_zones, and for the whole market at once use market_liquidations. The plain-English name for liquidations (identical data and credit cost). Descriptive market data only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | No | Alias for pair. | |
| pair | No | e.g. ETH/USD. A bare symbol like ETH also works. | |
| hours | No | Look back this many hours, up to 720. Omit for the most recent events. | |
| limit | No | Max rows returned. Capped at 25 keyless and 1000 on a paid plan; asking for more returns the cap, and the payload says so in `capped`. count and the *_usd totals always cover the whole window regardless. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading. | |
| pair | No | The pair these events belong to. | |
| count | No | How many events fired in the whole window, not how many rows came back. | |
| capped | No | Present only when an argument was cut down to a ceiling. Absent means nothing was clamped, so a smaller number than you asked for is the data and not a limit. | |
| sources | No | How the events split between the streamed exchanges and Hyperliquid, and whether the Hyperliquid part is a sample. | |
| long_usd | No | Dollars of longs force-closed across the window. | |
| available | No | False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess. | |
| short_usd | No | Dollars of shorts force-closed across the window. | |
| truncated | No | True when more rows matched than were returned, so what you have is a page and not the whole set. | |
| access_note | No | What this connection could not return and what lifts it. Always pass this on to the user: it is the only place that information appears. | |
| liquidations | No | The events themselves, newest first: price, size in base and quote, side (long_liquidated or short_liquidated), exchange and time. A sample of the window when truncated is true. | |
| window_hours | No | The period the totals cover, in hours. | |
| rows_returned | No | How many event rows are actually in this reply. | |
| window_minutes | No | The same period in minutes. | |
| requested_hours | No | The period asked for, so a page can be told apart from a period. | |
| total_in_window | No | How many events the window holds in total. | |
| history_included | No | True when the recorded series was merged in, so a restart has not erased earlier events. | |
| total_volume_usd | No | Dollars forced out across the whole window. | |
| long_liquidations | No | COUNT of longs force-closed. For dollars read long_usd. | |
| rows_span_minutes | No | How far back the returned rows themselves reach. | |
| short_liquidations | No | COUNT of shorts force-closed. For dollars read short_usd. |