HIP-3 Builder Perps - Liquidations

Get HIP-3 aggregated liquidation volume

Get aggregated liquidation-related volume in time-bucketed intervals for a HIP-3 symbol. total_* covers all liquidation rows; long_* and short_* are directional-family subtotals and may not sum to total when upstream emits unclassified directions. Coverage is symbol-specific; verify the selected market before choosing a time range.

get/v1/hyperliquid/hip3/liquidations/{symbol}/volume

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/hyperliquid/hip3/liquidations/{symbol}/volume
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required
Example:hyna:BTC

HIP-3 trading pair symbol (e.g., hyna:BTC, km:US500). Case-sensitive.

Query parameters

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

Start timestamp. Defaults to 24 hours ago. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

integer

Unix milliseconds.

OR
string date-time

RFC 3339 instant.

Example:1767225600000

End timestamp. Defaults to now. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.

cursorstring

Opaque pagination cursor: pass meta.next_cursor from the previous page unchanged, with the same filters. Omit it for the first page.

limitinteger

Maximum buckets to return (default: 100, max: 1000).

interval'1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d'

Aggregation interval

Response

Aggregated liquidation volume data

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "symbol": "BTC",
      "coin": "BTC",
      "timestamp": "2025-05-21T10:00:00.000Z",
      "total_usd": 1250000.5,
      "long_usd": 750000.25,
      "short_usd": 500000.25,
      "count": 42,
      "long_count": 25,
      "short_count": 17
    }
  ],
  "meta": {
    "symbol": "BTC",
    "venue": "hyperliquid"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.