L4PerpBookSnapshot

Get L4 orderbook snapshot for perpetual markets.

💧 New endpoint - this endpoint is not a part of original Hyperliquid API and is added by us for builder convenience.

Overview

The l4Book endpoint returns L4 orderbook snapshots. It includes all resting limit orders on the book with user addresses, but does not include trigger orders (stop-loss, take-profit) unless they have been triggered and placed on the book.

Key details:

  • Refreshed every second

  • Perpetual markets by default; outcome markets available via marketTypes or explicit coins

  • Includes user address for each order

Request

Endpoint: POST /info

All markets (perps only — default):

{
    "type": "l4Book"
}

All markets, perps + outcomes:

{
    "type": "l4Book",
    "marketTypes": ["perp", "outcome"]
}

Specific coins (any market type):

Parameters:

Parameter
Type
Required
Description

coins

string[]

No

Specific markets to fetch. Omit for all markets.

marketTypes

string[]

No

All-markets only. Each entry is "perp", "spot", "outcome", or the wildcard "*" (alone) for every type the server currently tracks. Omit for ["perp"] (default). Rejected if combined with coins.

Response

Headers:

  • Content-Type: application/octet-stream

  • x-payload-format: multi-zstd

  • x-compression: inner-zstd

Format: Multi-zstd binary format

Each blob is a zstd-compressed msgpack market snapshot:

Example

Rate limits

  • 10 requests per 5 minutes

Common errors

  • 403: Permission denied - check API key

  • 404: No snapshot available yet - retry shortly

  • 429: Rate limit exceeded

Last updated