---
title: "Get Hl Liquidations"
method: GET
path: "/api/v1/backtesting/hl-liquidations"
tags: ["Backtesting"]
---

# Get Hl Liquidations

`GET /api/v1/backtesting/hl-liquidations`

## Request

- Base URL: `https://cryptodataapi.com`
- URL: `https://cryptodataapi.com/api/v1/backtesting/hl-liquidations`
- Auth: API key in header `X-API-Key`

Query the per-event Hyperliquid liquidation tape.

Exact liquidation fills (market + backstop) across the full HL perp
universe — time, coin, liquidated side, px, sz, USD notional, method,
mark price, liquidated user and tx hash — unlike ``/backtesting/liquidations``'
venue-merged rolling-24h totals. Rows are ordered by the full ``(time, tid)``
key and ``next_cursor`` resumes exactly there: one liquidation order sweeping
N book levels is N rows at ONE ``time``, so ``start = last.time + 1`` paging
silently drops the siblings that fell past a page boundary — use the cursor.

Live capture began 2026-07-23 (``coverage.local_first`` is authoritative);
the ``hl_liquidations`` daily Parquet archive additionally holds a pilot
backfill 2026-04-24 → 2026-05-05. A window that starts before local
retention returns ``[]`` with ``coverage.archive_hint`` set rather than
silently. Pro (Pro Plus included) since 2026-09-07; the archive itself stays
Pro Plus. Bucketed flow from these fills: ``/backtesting/hl-liquidation-bars``.

## Query parameters

- `coin` string: One HL universe coin name (BTC, kPEPE) or a comma list (up to 25; every value rides the index). Omit for all coins.
- `start` string, required: Start time (ISO 8601 or unix ms)
- `end` string: End time (ISO 8601 or unix ms, defaults to now). EXCLUSIVE — the range is [start, end), so consecutive windows do not repeat a boundary row.
- `bounds` string: Interval convention for `start`/`end`. `half-open` (default) is [start, end) — `end` is EXCLUSIVE, so consecutive windows tile without repeating a boundary row. `closed` is [start, end] — `end` INCLUSIVE, the pre-2026-08-08 behaviour; use it only to keep an existing integration byte-identical.
- `limit` integer
- `cursor` string, nullable: Opaque page cursor — the `next_cursor` of the previous response, verbatim. Resumes strictly after the last row served, keyed on the table's full primary key, so a page boundary inside a same-millisecond burst loses nothing (unlike `start = last.time + 1`). `start` / `end` still bound the window.
- `format` string: json or csv. CSV has no envelope: paging state travels in the `X-Has-More` / `X-Next-Cursor` response headers.

## Response `200`

Successful Response

- BacktestHLLiquidationsResponse
  - `grain` GrainDescriptor: What ONE ROW of a series is, stated on the payload so it cannot be mis-summed. ``kind``: ``event`` (one fill), ``bar`` (a closed bucket), ``rate_snapshot`` (the live rate sampled on a timer), ``rolling_window`` (a trailing total sampled on a timer), ``settled_payment`` (one settlement print). ``sum_ok`` — adding rows across time is meaningful. ``is_cumulative`` — a row already contains its predecessors' flow. ``settlements_per_day`` is set for funding series only.
    - `kind` string, required
    - `cadence` string, nullable
    - `is_cumulative` boolean
    - `sum_ok` boolean
    - `window` string, nullable
    - `settlements_per_day` integer, nullable
    - `note` string, required
  - `coverage` CoverageInfo: Local retention bounds (ms) for the queried scope. ``archive_hint`` is set when the window starts before ``local_first`` — those rows are not missing, they live in the daily Parquet archive.
    - `local_first` integer, nullable
    - `local_last` integer, nullable
    - `archive_hint` string, nullable
  - `next_cursor` string, nullable
  - `has_more` boolean
  - `coin` string, nullable, required
  - `count` integer, required
  - `data` BacktestHLLiquidationEvent[], required
    - `time` integer, required
    - `tid` integer, required
    - `coin` string, required
    - `symbol` string, required
    - `side` string, required
    - `px` number, nullable
    - `sz` number, nullable
    - `usd` number, nullable
    - `method` string, nullable
    - `mark_px` number, nullable
    - `liquidated_user` string, nullable
    - `hash` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/cryptodataapi/apis/crypto-data-api.md) · [All operations](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/revisions/8628b754ca81?raw)