HIP-3 - Liquidations

Get HIP-3 liquidation levels

Projected forced-liquidation levels computed from clearinghouse positions and margin state, aggregated into price buckets around the snapshot mark price. Snapshots are computed roughly every 5 minutes; the response's snapshot_ts identifies the snapshot served. Historical snapshots are retained from 2026-07-27: use the at parameter for a point-in-time read, or the /history variant to enumerate snapshots with cursor pagination. Available on every plan; the endpoint carries a premium per-request credit cost. Note: before 2026-07-27 this path served a pending trigger-order map; that data now lives at /orders/{symbol}/trigger-levels. For HIP-3, cross-margined exposure is reported in flagged_notional and excluded from buckets.

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

Request

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

Path parameters

symbolstring required
Example:xyz:TSLA

Trading pair symbol.

Query parameters

range_pctnumber

Percentage range around the snapshot mid/mark price. Clamped between 1 and 50. Default 10.

bucketsinteger

Number of price buckets. Clamped between 10 and 200. Default 50.

side'bid' | 'ask' | 'buy' | 'sell' | 'B' | 'A'

Optional side filter. bid/buy/B keeps the long (or bid) side, ask/sell/A keeps the short (or ask) side; the other side is zeroed.

atinteger

Point-in-time read: epoch milliseconds (UTC). Serves the newest snapshot at or before this instant. Omit for the latest snapshot. History begins 2026-07-27; earlier instants return 404.

Response

Get HIP-3 liquidation levels

successboolean

Example response

{
  "success": true,
  "data": {
    "mid_price": 64215
  }
}

Changes

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