---
title: "Get Hl Trade Flow"
method: GET
path: "/api/v1/backtesting/hl-trade-flow"
tags: ["Backtesting"]
---

# Get Hl Trade Flow

`GET /api/v1/backtesting/hl-trade-flow`

## Request

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

Query the archived Hyperliquid trade tape: 1-minute taker buy/sell
buckets per perp.

Each row is one closed UTC minute for one coin — ``buy_notional`` /
``sell_notional`` by aggressor side, ``n_trades``, ``vwap``,
``max_fill_usd``, ``large_fill_share`` (fills >= $25k) and ``partial``
(the collector's socket did not watch the whole minute; such minutes are
never back-filled). Same row shape as the live ``/hyperliquid/trade-flow``
minus its served-only ``cvd_usd``. Minutes with no fills are NOT stored.
Serves the local retention window; the full history is archived daily as
the ``hl_trade_flow`` data type (one Parquet per day, all coins — see
``/backtesting/archives``). Coverage begins 2026-09-09. Pro (Pro Plus
included), matching ``/hl-liquidations``; the archive stays Pro Plus.

## Query parameters

- `coin` string: One HL 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

- BacktestHLTradeFlowResponse
  - `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` BacktestHLTradeFlowBucket[], required
    - `time` integer, required
    - `coin` string, required
    - `buy_notional` number, nullable, required
    - `sell_notional` number, nullable, required
    - `n_trades` integer, nullable, required
    - `vwap` number, nullable, required
    - `max_fill_usd` number, nullable, required
    - `large_fill_share` number, nullable, required
    - `partial` boolean, required

## 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)