> ## 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.

# API Documentation

> Hyperliquid and Lighter market data through the REST API, WebSocket, Webhook Alerts, and Bulk Exports. Start with your first request on the Free plan.

Start with the Quickstart, then choose the product that fits your job.

<Card title="Quickstart" icon="rocket" href="/quickstart" horizontal>
  Create a key on the Free plan and make your first request.
</Card>

## Products

All four cover Hyperliquid and Lighter, but the datasets and history differ by product. [Choose a product](/data) compares them and how you sign in to each one.

<CardGroup cols={2}>
  <Card title="REST API" icon="square-terminal" href="/rest-api">
    Request snapshots and history: Hyperliquid L4 and Lighter L3 order books, trades, candles, funding, and more.
  </Card>

  <Card title="WebSocket" icon="radio" href="/websocket">
    Stream live updates, or replay history in its original order.
  </Card>

  <Card title="Webhook Alerts" icon="bell" href="/webhooks">
    Receive a signed HTTP request when an event happens, instead of polling.
  </Card>

  <Card title="Bulk Exports" icon="file-down" href="/data-catalog">
    Buy Parquet files for a market and date range in the Data Catalog.
  </Card>
</CardGroup>

## Developer tools

* [SDKs](/sdks): typed clients for Python, TypeScript, and Rust.
* [CLI](/cli): the `oxa` command for shells, cron jobs, and CI.
* [MCP server](/mcp-server): market data inside AI clients such as Claude and ChatGPT.
* [Agent skill](/skill): a reusable workflow for coding agents.

The REST API, WebSocket, the SDKs, the CLI, and the Agent skill use an API key. The MCP server signs in with OAuth, and Bulk Exports are bought in the browser, so neither needs an API key.

## Your first request

With an API key in your shell, this returns the best bid and ask for BTC:

```bash theme={"theme":"github-dark"}
export OXARCHIVE_API_KEY="0xa_your_api_key"
curl "https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC?depth=1" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"
```

A successful call returns HTTP `200` with `success: true`, the order book in `data`, and a `meta.request_id` to quote if you contact support.

## Before you rely on a result

0xArchive serves historical and live data for Hyperliquid and Lighter, and coverage is checked per symbol and data type, not per venue.

* Which API namespace a market uses: [Venues and market types](/core-concepts/venue-taxonomy).
* Which routes serve Hyperliquid core data: [Hyperliquid core REST API](/rest-api/hyperliquid).
* How far back Hyperliquid core history goes: [Hyperliquid historical data API](/hyperliquid-historical-data-api).
* Whether a symbol and window are covered: [Venue coverage](/venue-coverage).
* Freshness, incidents, and gaps for a window: [Data quality](/data-quality).
* Requests, credits, and connections per plan: [Rate limits](/rate-limits).
* What you may store, share, or resell: [Data rights](/data-rights).

## Next step

<Card title="Make your first request" icon="rocket" href="/quickstart">
  The Quickstart walks through the full response, the errors you are most likely to see, and the same call in Python and JavaScript.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.