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.

Hyperliquid core is the REST family for standard perp markets such as BTC and ETH. Use it for market state, history, order flow, and depth when the symbol is not a Spot pair, HIP-3 builder prefix, HIP-4 outcome side, or Lighter instrument.

Order books

Current and historical depth for core perp markets.

Trades

Executions with timestamp, side, price, size, and source-specific fields.

Funding and OI

Funding rates, premium fields, marks, mids, and open interest.

L4 and orders

Order-level depth and lifecycle surfaces where your access allows them.

First Request

curl "https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

When To Use It

Use this namespace when the market is a core Hyperliquid perp and the symbol does not require a builder prefix or outcome-market side identifier. Use a different family when the user gives a pair such as HYPE-USDC, a builder market such as km:US500, a # outcome side, or a Lighter instrument. The wrong namespace can return a valid-looking request shape while pulling the wrong market family.

Available Route Groups

Core Hyperliquid routes cover current and historical market-state work: order books, trades, candles, funding, open interest, liquidations, order history, and L4/order-level surfaces where supported by the account. Confirm the path with /v1/hyperliquid/orderbook/BTC, then add history, funding, OI, or L4 after auth, response shape, and data-quality checks are working.

Core Request Packet

Use this packet when a client, generated test, or coding agent is about to call core Hyperliquid routes.
FieldCore-family value
Namespace/v1/hyperliquid/*
Symbol stylePlain perp symbols such as BTC or ETH
Excluded stylesSpot pairs, HIP-3 builder prefixes, HIP-4 outcome IDs, and Lighter symbols
First probeCurrent order book, trades page, candle page, or freshness check for one symbol
Widening ruleAdd history, pagination, or L4 only after auth, response shape, and request-ID logging work

Storage And Quality

Separate this family from Hyperliquid Spot, HIP-3, HIP-4, and Lighter. A standard perp symbol such as BTC belongs here. A pair such as HYPE-USDC belongs to Hyperliquid Spot. A namespaced builder symbol such as km:US500 belongs to HIP-3. A # outcome side belongs to HIP-4. For backtests, store the route, query parameters, time window, cursor, and request_id. Pair the market-data pull with /v1/data-quality/* so downstream users know whether the result came from a clean enough window.

Product Uses

This family is built for Hyperliquid perp history without a venue-ingestion pipeline: backtests, risk views, liquidation monitors, funding and OI dashboards, order-flow studies, and local book reconstruction. Raw execution, wallet signing, and venue account actions still belong in native Hyperliquid surfaces; 0xArchive documents market data and historical retrieval. Open Order Book Routes for depth selection, Trades And Liquidations for event history, or Funding, Open Interest, And Candles for time-series context.

Client Rule

Use this family only for core Hyperliquid perp markets. If the job mentions a pair, prefix, outcome side, or Lighter market, switch to the corresponding family before writing requests. Keep core perp examples separate from Spot, HIP-3, HIP-4, and Lighter examples.
Last modified on May 18, 2026