---
title: "Get Hyperliquid breadth above session VWAP history"
method: GET
path: "/v1/hyperliquid/breadth/above-vwap"
tags: ["Hyperliquid - Breadth"]
---

# Get Hyperliquid breadth above session VWAP history

`GET /v1/hyperliquid/breadth/above-vwap`

## Request

- Base URL: `https://api.0xarchive.io`
- URL: `https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap`
- Auth: API key in header `X-API-Key`

Get historical aggregate Hyperliquid core perpetual breadth snapshots. Each row reports the percentage of eligible instruments above their current UTC-session VWAP and its auditable counts. Eligibility excludes instruments with no session volume or a last completed candle older than 5 minutes. Coverage reflects per-instrument eligibility at the calculation cutoff. `start` and `end` are Unix timestamps in milliseconds. If omitted, `start` defaults independently to now minus 24 hours and `end` defaults to now; the start default is not derived from a supplied `end`. The optional `interval` downsamples by selecting the last stored snapshot in each bucket; percentages are never averaged because the denominator can vary. The optional `cursor` is an epoch-millisecond timestamp from `meta.next_cursor` and is exclusive. Validated snapshots are stored every minute when the calculation passes its invariants; failed or invalid calculations do not create a row. `calculated_at` is the UTC cutoff used to calculate each validated snapshot, not a source-freshness guarantee. Core history begins 2026-08-24; values before 2026-08-31 13:43 UTC were recomputed from canonical settled candles with a point-in-time registry, not synthesized. `counts.candidates` is the cumulative candidate universe considered at each cutoff, not a fixed inventory and not guaranteed to increase monotonically in historical data.

## Query parameters

- `start` union: An instant: Unix milliseconds, or an RFC 3339 string such as `2026-01-01T00:00:00Z` (encode a `+` offset as `%2B`). An unparsable value answers 400 `invalid_time_range`.
  - integer: Unix milliseconds.
  - string, date-time: RFC 3339 instant.
- `end` union: An instant: Unix milliseconds, or an RFC 3339 string such as `2026-01-01T00:00:00Z` (encode a `+` offset as `%2B`). An unparsable value answers 400 `invalid_time_range`.
  - integer: Unix milliseconds.
  - string, date-time: RFC 3339 instant.
- `cursor` string
- `limit` integer
- `interval` '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d'

## Response `200`

Historical Hyperliquid breadth snapshots

- ApiResponseBreadthSnapshotArray
  - `success` boolean
  - `data` BreadthSnapshot[]
    - `session_date` string, date, required: UTC session date.
    - `calculated_at` string, date-time, required: UTC calculation cutoff for this validated snapshot. It identifies the cutoff used for included candle data and is not a source-freshness guarantee.
    - `value_pct` number, double, nullable, required: 100 times above divided by eligible; null when eligible is zero and never interpret null as 0%.
    - `coverage_ratio` number, double, required: Eligible divided by candidates, constrained to the range 0..1.
    - `counts` BreadthCounts, required: Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot.
      - `candidates` integer, required: Cumulative candidate instruments considered at this calculation cutoff. This is not a fixed inventory, and candidate counts are not guaranteed to be monotonic across historical snapshots.
      - `eligible` integer, required: Eligible instruments included in the headline percentage.
      - `above` integer, required: Eligible instruments trading above their current UTC-session VWAP.
      - `at` integer, required: Eligible instruments at their current UTC-session VWAP.
      - `below` integer, required: Eligible instruments trading below their current UTC-session VWAP.
      - `excluded_no_session_volume` integer, required: Candidates excluded because the current UTC session has no qualifying volume.
      - `excluded_stale_price` integer, required: Candidates with session volume excluded because their most recent completed 1-minute candle close was older than the 5-minute freshness threshold at the calculation cutoff. Candidates without session volume are counted only in excluded_no_session_volume.
    - `namespaces` BreadthNamespaceCounts, required: Per-namespace count breakdowns for the shared core and HIP-3 breadth shape. Core perpetual responses always return empty maps. HIP-3 responses use builder namespace keys where counts are nonzero, so an individual map may be empty.
      - `eligible` object, required: Eligible instrument counts by builder namespace for HIP-3; always empty for core perpetuals.
      - `above` object, required: Above-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.
      - `at` object, required: At-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.
      - `below` object, required: Below-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.
  - `meta` ResponseMeta: Response metadata. Every 2xx JSON response carries `meta.request_id`; list payloads add `count`; cursor-paged routes add `has_more` and, when another page follows, `next_cursor`; per-symbol routes add `symbol` and `venue`. Fields that do not apply to a route are omitted.
    - `count` integer: Number of records returned
    - `has_more` boolean: Cursor-paged routes: whether another page follows. `next_cursor` is present exactly when this is `true`. A final page can be empty when the previous page was exactly full; `has_more` is `false` on it.
    - `next_cursor` string: Opaque cursor for the next page, present exactly when `has_more` is `true`. Pass it back unchanged as `cursor` with the same filters. Do not parse or construct it.
    - `request_id` string, uuid, required: Unique request ID for support
    - `symbol` string: Per-symbol routes: the canonical public symbol the response describes (for example `BTC`, `xyz:TSLA`, `HYPE-USDC`, `#0`).
    - `venue` 'hyperliquid' | 'hip3' | 'hip4' | 'spot' | 'lighter' | 'rh-lighter': Per-symbol routes: the venue the response describes.
    - `coverage_from` string, date-time: Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.
    - `notice` string: Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.
    - `finalized_through` string, date-time: Two-tier datasets (Lighter trades): data at or before this instant is final; later data is preliminary.
    - `requested_end` string, date-time, nullable: The `end` the request asked for, echoed when it was clamped to `finalized_through`.
    - `clamped_to` string, date-time, nullable: The boundary the request's `end` was clamped to, when clamping occurred.
    - `preliminary_row_count` integer, nullable: Number of preliminary rows in this response, on routes that intentionally serve preliminary data (Lighter `/recent`).

## Other responses

- `400`: Invalid request: a parameter, symbol, interval, cursor or time range failed validation. See `error_code`.
- `401`: Authentication required: the API key is missing or invalid.
- `403`: The request is outside the plan's history window or per-request span, or the key is not allowed to make it.
- `429`: Rate limit, concurrency limit or monthly credits exceeded. See `error_code`.
- `default`: Any other error. The body is an `ErrorResponse`; branch on `error_code`. A 503 (`upstream_unavailable`) carries `Retry-After`.

---

[API](https://skmtc.dev/0xarchive/apis/0xarchive-api-2.md) · [All operations](https://skmtc.dev/0xarchive/apis/0xarchive-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/0xarchive/apis/0xarchive-api-2/revisions/27076f55595f?raw)