HIP-3 REST API

HIP-3 builder-perp REST routes under the Hyperliquid namespace, including depth, candles, order flow, liquidations, credits, and example requests. 25 documented routes.

Routes
25 documented routes
Scope
Builder perps
Namespace
Hyperliquid HIP-3
Includes
Order flow, L4, liquidations
OpenAPI Spec

HIP-3

Builder-perp routes inside the Hyperliquid namespace, including depth, liquidations, and order flow.

Hyperliquid HIP-3 - Instruments (125+ markets: xyz, flx, hyna, km, vntl, cash)

GET/v1/hyperliquid/hip3/instruments1 credit

List all available HIP-3 builder-deployed perpetuals with latest market data (mark price, open interest, mid price).

List all available HIP-3 builder-deployed perpetuals with latest market data (mark price, open interest, mid price). No tier restriction - useful for market inventory.

Request

/v1/hyperliquid/hip3/instruments

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "exchange": "hyperliquid_hip3",
      "quote": "USDC",
      "active": true
    },
    {
      "symbol": "xyz:XYZ100",
      "exchange": "hyperliquid_hip3",
      "quote": "USDC",
      "active": true
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 2
  }
}
GET/v1/hyperliquid/hip3/instruments/:symbol1 credit

Get a specific HIP-3 instrument by symbol.

Get a specific HIP-3 instrument by symbol. Returns latest market data.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive.

Request

/v1/hyperliquid/hip3/instruments/km:US500

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "exchange": "hyperliquid_hip3",
    "base": "US500",
    "quote": "USDC",
    "active": true,
    "tick_size": "0.5",
    "lot_size": "0.001"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}

Hyperliquid HIP-3 - Order Book (Free: km:US500, Build+: all)

GET/v1/hyperliquid/hip3/orderbook/:symbol1 credit

Get current order book or snapshot at specific timestamp for HIP-3 builder-deployed perpetuals.

Get current order book or snapshot at specific timestamp for HIP-3 builder-deployed perpetuals. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
timestampqueryUnix timestamp in ms for historical snapshot
depthqueryNumber of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth

Request

/v1/hyperliquid/hip3/orderbook/xyz:XYZ100?depth=50

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "timestamp": "2026-01-01T12:00:00Z",
    "bids": [
      {
        "px": "42150.50",
        "sz": "2.5",
        "n": 5
      }
    ],
    "asks": [
      {
        "px": "42151.00",
        "sz": "1.8",
        "n": 3
      }
    ],
    "mid_price": "42150.75",
    "spread": "0.50",
    "spread_bps": "1.19"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/history5 credits

Get historical order book snapshots with cursor pagination.

Get historical order book snapshots with cursor pagination. Returns sub-second L1 snapshots — for tick-level order changes use /hip3/orderbook/:symbol/l4/diffs (Pro+) or /hip3/orderbook/:symbol/l2/diffs. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)
depthqueryNumber of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth

Request

/v1/hyperliquid/hip3/orderbook/xyz:XYZ100/history?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "bids": [
        {
          "px": "42150.50",
          "sz": "2.5",
          "n": 5
        }
      ],
      "asks": [
        {
          "px": "42151.00",
          "sz": "1.8",
          "n": 3
        }
      ],
      "mid_price": "42150.75",
      "spread": "0.50"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - Trades (Free: km:US500, Build+: all)

GET/v1/hyperliquid/hip3/trades/:symbol2 credits

Get trade history with cursor pagination.

Get trade history with cursor pagination. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryCursor from previous response (next_cursor)
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/trades/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=1000

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "side": "B",
      "price": "42150.50",
      "size": "0.25",
      "trade_id": 12345678,
      "direction": "Open Long"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/trades/:symbol/recent1 credit

Get most recent trades for a HIP-3 symbol.

Get most recent trades for a HIP-3 symbol. Data available from February 2026. No tier restriction.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
limitqueryNumber of trades to return (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/trades/xyz:XYZ100/recent?limit=50

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "side": "B",
      "price": "42150.50",
      "size": "0.25",
      "trade_id": 12345678,
      "direction": "Open Long"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - Candles (Free: km:US500, Build+: all)

GET/v1/hyperliquid/hip3/candles/:symbol3 credits

Get OHLCV candle data aggregated from HIP-3 trades.

Get OHLCV candle data aggregated from HIP-3 trades. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive.
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
intervalqueryCandle interval: 1m, 5m, 15m, 30m, 1h (default), 4h, 1d, 1w
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/candles/km:US500?start=1739750400000&end=1739836800000&interval=1h&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "interval": "1h",
      "open": "42100.00",
      "high": "42200.00",
      "low": "42050.00",
      "close": "42180.00",
      "volume": "125.5"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - Market Data (Free: km:US500, Build+: all)

GET/v1/hyperliquid/hip3/openinterest/:symbol2 credits

Get historical open interest data.

Get historical open interest data. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryCursor from previous response (next_cursor)
limitqueryMax results (default: 100, max: 1000)
intervalqueryAggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data.

Request

/v1/hyperliquid/hip3/openinterest/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "open_interest": "12500.5",
      "mark_price": "42150.75"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/openinterest/:symbol/current1 credit

Get current open interest for a HIP-3 symbol.

Get current open interest for a HIP-3 symbol. No tier restriction.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)

Request

/v1/hyperliquid/hip3/openinterest/xyz:XYZ100/current

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "timestamp": "2026-01-01T12:00:00Z",
    "open_interest": "12500.5",
    "mark_price": "42150.75"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}
GET/v1/hyperliquid/hip3/funding/:symbol2 credits

Get historical funding rates.

Get historical funding rates. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryCursor from previous response (next_cursor)
limitqueryMax results (default: 100, max: 1000)
intervalqueryAggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data.

Request

/v1/hyperliquid/hip3/funding/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "funding_rate": "0.0001",
      "premium": "0.00005"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/funding/:symbol/current1 credit

Get current funding rate for a HIP-3 symbol.

Get current funding rate for a HIP-3 symbol. No tier restriction.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)

Request

/v1/hyperliquid/hip3/funding/xyz:XYZ100/current

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "timestamp": "2026-01-01T12:00:00Z",
    "funding_rate": "0.0001",
    "premium": "0.00005"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}

Hyperliquid HIP-3 - Liquidations (Build+)

GET/v1/hyperliquid/hip3/liquidations/:symbol3 credits

Get liquidation-related fills for a HIP-3 symbol.

Get liquidation-related fills for a HIP-3 symbol. Returns the liquidated user plus counterparty/liquidator attribution when present, alongside price, size, side, and direction labels. Data available from February 2026+.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive.
startqueryrequiredStart timestamp in ms
endqueryEnd timestamp in ms. Defaults to now.
cursorqueryCursor from previous response (format: timestamp_tradeId)
limitqueryMax results (default: 1000, max: 1000)

Request

/v1/hyperliquid/hip3/liquidations/km:US500?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "liquidated_user": "0x1234...abcd",
      "side": "B",
      "price": "42150.50",
      "size": "1.5",
      "direction": "Close Long"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/liquidations/:symbol/volume3 credits

Get pre-aggregated liquidation-related volume in time-bucketed intervals for HIP-3 symbols.

Get pre-aggregated liquidation-related volume in time-bucketed intervals for HIP-3 symbols. total_* covers all liquidation rows; long_* and short_* are directional-family subtotals and may not sum to total when upstream emits unclassified directions. Data available from February 2026+.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive.
startqueryrequiredStart timestamp in ms
endqueryEnd timestamp in ms. Defaults to now.
intervalqueryAggregation interval: 5m, 15m, 30m, 1h (default), 4h, 1d
limitqueryMax results (default: 1000, max: 1000)
cursorqueryPagination cursor from previous response

Request

/v1/hyperliquid/hip3/liquidations/km:US500/volume?start=1739750400000&end=1739836800000&interval=1h&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "interval": "1h",
      "long_volume": "125000.50",
      "short_volume": "98000.25",
      "count": 14
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - Convenience

GET/v1/hyperliquid/hip3/freshness/:symbol1 credit

Check when data was last updated for each data type (orderbook, trades, funding, OI) for a specific HIP-3 symbol.

Check when data was last updated for each data type (orderbook, trades, funding, OI) for a specific HIP-3 symbol. Symbol names are case-sensitive.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100)

Request

/v1/hyperliquid/hip3/freshness/km:US500

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "exchange": "hyperliquid_hip3",
    "latest_timestamp": "2026-01-01T12:00:00Z",
    "lag_ms": 1200,
    "status": "fresh"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}
GET/v1/hyperliquid/hip3/summary/:symbol2 credits

Get a combined market summary for a HIP-3 symbol in a single API call.

Get a combined market summary for a HIP-3 symbol in a single API call. Returns latest price, mid price, funding rate, and open interest.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100)

Request

/v1/hyperliquid/hip3/summary/km:US500

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "mark_price": "42150.75",
    "mid_price": "42150.75",
    "open_interest": "12500.5",
    "volume_24h": "1250000000",
    "timestamp": "2026-01-01T12:00:00Z"
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}
GET/v1/hyperliquid/hip3/prices/:symbol2 credits

Get mark, oracle, and mid price history for a HIP-3 symbol.

Get mark, oracle, and mid price history for a HIP-3 symbol. Lightweight projection of open interest data. Supports time aggregation intervals. Symbol names are case-sensitive.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., km:US500, xyz:XYZ100)
startqueryStart timestamp (Unix ms or ISO 8601). Defaults to 24h ago.
endqueryEnd timestamp (Unix ms or ISO 8601). Defaults to now.
intervalqueryAggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw data.
limitqueryMax results (default: 100, max: 1000)
cursorqueryPagination cursor from previous response

Request

/v1/hyperliquid/hip3/prices/km:US500?start=1739750400000&end=1739836800000&interval=1h&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "mark_price": "42150.75",
      "oracle_price": "42148.50",
      "mid_price": "42150.75"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - L4 Order Book (Node-Level)

GET/v1/hyperliquid/hip3/orders/:symbol/history5 credits

Get HIP-3 order history with user attribution from Hyperliquid node data.

Get HIP-3 order history with user attribution from Hyperliquid node data. Includes order placements, cancellations, and fills. Requires Pro tier or higher.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
userqueryFilter by user wallet address (e.g., 0x...)
statusqueryFilter by order status (e.g., open, filled, cancelled)
order_typequeryFilter by order type (e.g., limit, market)
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orders/km:US500/history?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "order_id": "0xabc",
      "user_address": "0x1234...abcd",
      "status": "filled",
      "side": "B",
      "price": "42150.50",
      "size": "1.2"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orders/:symbol/flow5 credits

Get aggregated order flow data for HIP-3 markets showing buy/sell pressure over time intervals.

Get aggregated order flow data for HIP-3 markets showing buy/sell pressure over time intervals. Requires Pro tier or higher.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
intervalqueryAggregation interval (e.g., 1m, 5m, 15m, 1h)
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orders/km:US500/flow?start=1739750400000&end=1739836800000&interval=5m&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "interval": "5m",
      "new_orders": 1250,
      "cancels": 1180,
      "fills": 340,
      "net_size": "42.5"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orders/:symbol/tpsl5 credits

Get HIP-3 take-profit and stop-loss order history with user attribution.

Get HIP-3 take-profit and stop-loss order history with user attribution. Shows triggered and untriggered TP/SL orders. Requires Pro tier or higher.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
userqueryFilter by user wallet address (e.g., 0x...)
triggeredqueryFilter by triggered status (true/false)
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orders/km:US500/tpsl?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "order_id": "0xabc",
      "trigger_price": "42000.00",
      "order_type": "stop_market",
      "side": "A",
      "size": "0.5"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/l410 credits

Reconstruct the HIP-3 L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level.

Reconstruct the HIP-3 L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level. Requires Pro tier or higher. Data available from March 11, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
timestampqueryrequiredUnix timestamp in ms for reconstruction point
depthqueryNumber of price levels per side (default: 20)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l4?timestamp=1739750400000&depth=20

Response

{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "timestamp": "2026-03-11T12:00:00Z",
    "bids": [
      {
        "price": "42150.50",
        "orders": [
          {
            "order_id": "0xabc",
            "user_address": "0x1234...abcd",
            "size": "2.5"
          }
        ]
      }
    ],
    "asks": [
      {
        "price": "42151.00",
        "orders": [
          {
            "order_id": "0xdef",
            "user_address": "0x5678...efgh",
            "size": "1.8"
          }
        ]
      }
    ]
  },
  "meta": {
    "request_id": "req_abc123",
    "count": 1
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/l4/diffs5 credits

Get HIP-3 L4 orderbook diffs showing individual order changes with user attribution.

Get HIP-3 L4 orderbook diffs showing individual order changes with user attribution. Each diff represents an order placement, cancellation, or fill. Requires Pro tier or higher. Data available from March 10, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l4/diffs?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-03-11T12:00:00Z",
      "bids": [
        {
          "price": "42150.50",
          "orders": [
            {
              "order_id": "0xabc",
              "user_address": "0x1234...abcd",
              "size": "2.5"
            }
          ]
        }
      ],
      "asks": [
        {
          "price": "42151.00",
          "orders": [
            {
              "order_id": "0xdef",
              "user_address": "0x5678...efgh",
              "size": "1.8"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/l4/history10 credits

Get HIP-3 L4 orderbook checkpoints (full snapshots) with user attribution at each price level.

Get HIP-3 L4 orderbook checkpoints (full snapshots) with user attribution at each price level. Useful for periodic state verification. Requires Build tier or higher. Data available from March 11, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:XYZ100, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l4/history?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-03-11T12:00:00Z",
      "bids": [
        {
          "price": "42150.50",
          "orders": [
            {
              "order_id": "0xabc",
              "user_address": "0x1234...abcd",
              "size": "2.5"
            }
          ]
        }
      ],
      "asks": [
        {
          "price": "42151.00",
          "orders": [
            {
              "order_id": "0xdef",
              "user_address": "0x5678...efgh",
              "size": "1.8"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}

Hyperliquid HIP-3 - L2 Full-Depth Order Book (Derived from L4)

GET/v1/hyperliquid/hip3/orderbook/:symbol/l23 credits

Get the HIP-3 full-depth L2 orderbook at a specific point in time, derived from L4 data.

Get the HIP-3 full-depth L2 orderbook at a specific point in time, derived from L4 data. Returns aggregated price levels. If no timestamp is provided, returns the current state. Requires Build tier or higher. Data available from April 1, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:CL, km:US500)
timestampqueryUnix timestamp in ms (omit for current state)
depthqueryNumber of price levels per side (omit for full depth)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l2?depth=20

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "bids": [
        {
          "px": "42150.50",
          "sz": "2.5",
          "n": 5
        }
      ],
      "asks": [
        {
          "px": "42151.00",
          "sz": "1.8",
          "n": 3
        }
      ],
      "mid_price": "42150.75",
      "spread": "0.50"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/l2/history10 credits

Get paginated HIP-3 L2 full-depth checkpoints over a time range.

Get paginated HIP-3 L2 full-depth checkpoints over a time range. Each checkpoint is a complete orderbook snapshot. Requires Build tier or higher. Data available from April 1, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:CL, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l2/history?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "bids": [
        {
          "px": "42150.50",
          "sz": "2.5",
          "n": 5
        }
      ],
      "asks": [
        {
          "px": "42151.00",
          "sz": "1.8",
          "n": 3
        }
      ],
      "mid_price": "42150.75",
      "spread": "0.50"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}
GET/v1/hyperliquid/hip3/orderbook/:symbol/l2/diffs5 credits

Get tick-level HIP-3 L2 orderbook deltas showing price-level changes over time.

Get tick-level HIP-3 L2 orderbook deltas showing price-level changes over time. Each delta contains price, new size, and side. Requires Pro tier or higher. Data available from April 1, 2026.

Parameters

symbolpathrequiredHIP-3 symbol (e.g., xyz:CL, km:US500)
startqueryrequiredStart timestamp in ms
endqueryrequiredEnd timestamp in ms
cursorqueryPagination cursor from previous response
limitqueryMax results (default: 100, max: 1000)

Request

/v1/hyperliquid/hip3/orderbook/km:US500/l2/diffs?start=1739750400000&end=1739836800000&limit=100

Response

{
  "success": true,
  "data": [
    {
      "symbol": "km:US500",
      "timestamp": "2026-01-01T12:00:00Z",
      "bids": [
        {
          "px": "42150.50",
          "sz": "2.5",
          "n": 5
        }
      ],
      "asks": [
        {
          "px": "42151.00",
          "sz": "1.8",
          "n": 3
        }
      ],
      "mid_price": "42150.75",
      "spread": "0.50"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "count": 1,
    "next_cursor": "1704067200000_abc123",
    "has_more": false
  }
}