Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt

Use this file to discover all available pages before exploring further.

Venue coverage is the routing decision before code: choose the 0xArchive venue family, namespace, symbol style, and data route before generating requests. 0xArchive exposes two top-level venue APIs: Hyperliquid and Lighter.xyz. Hyperliquid core perps, Hyperliquid Spot, HIP-3, and HIP-4 are separate Hyperliquid-scoped market families. Lighter routes stay under /v1/lighter/*.

Route Families

FamilyNamespaceSymbol styleCommon use
Hyperliquid core/v1/hyperliquid/*BTC, ETHPerp market data, long-window history, funding, OI, liquidations, L4
Hyperliquid Spot/v1/hyperliquid/spot/*Spot pairs such as HYPE-USDCSpot pairs, order books, trades, candles, L4 reconstruction, TWAP, freshness
HIP-3 builder perps/v1/hyperliquid/hip3/*builder:MARKET, for example km:US500Builder-perp markets under Hyperliquid
HIP-4 outcome markets/v1/hyperliquid/hip4/*Numeric or # side identifiersBinary outcome markets with probability-priced books, trades, candles, OI, and sides
Lighter.xyz/v1/lighter/*Lighter symbolsL2/L3 depth, trades, funding, OI, Lighter-specific reconstruction

Decision Order

1

Choose top-level venue

Start with Hyperliquid or Lighter.xyz. Lighter routes never live under the Hyperliquid namespace.
2

Choose Hyperliquid family

For Hyperliquid, separate core perps, Spot pairs, HIP-3 builder perps, and HIP-4 outcome markets before choosing a route.
3

Keep symbol style intact

Preserve plain perp symbols, Spot pair symbols, builder prefixes, and HIP-4 side identifiers in requests, logs, and storage.

Coverage Packet

Use this packet before generating routes, examples, or agent commands.
FieldCapture
Top-level venueHyperliquid or Lighter.xyz
Market familyCore, Spot, HIP-3, HIP-4, or Lighter
Symbol stylePlain perp, pair, builder prefix, outcome identifier, or Lighter symbol
Route namespaceExact namespace family before endpoint selection
First checkInstrument, coverage, freshness, or one bounded market-data request

Choosing Correctly

Start here for BTC, ETH, and other core Hyperliquid perp markets. Use route families for order books, trades, candles, funding, open interest, liquidations, orders, and L4 depth where your plan allows it.
Spot routes use pair symbols such as HYPE-USDC under /v1/hyperliquid/spot. Do not mix Spot pair routes with core perp, HIP-3, HIP-4, or Lighter routes.
HIP-3 symbols stay under the Hyperliquid namespace. Keep the builder prefix when you call routes, for example km:US500.
HIP-4 mark_price and mid_price values represent implied probability in the [0, 1] range, not a USD price. Outcome-market sides can use numeric identifiers and # forms.
Lighter is a separate top-level venue family. Do not route Lighter symbols through the Hyperliquid namespace.

REST API

Open the route atlas and generated reference.

Hyperliquid Spot

Query Spot pairs, order books, trades, candles, L4 reconstruction, TWAP, and freshness.

Lighter REST

Use the Lighter namespace for L2/L3 depth, trades, funding, OI, and freshness.

Historical data guide

Pull market history without mixing route families.
Last modified on May 18, 2026