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

> Use Hyperliquid Spot REST routes for pairs, order books, trades, candles, L4 reconstruction, TWAP, and freshness checks.

Hyperliquid Spot lives under `/v1/hyperliquid/spot`. Use pair symbols such as `HYPE-USDC` for Spot routes and keep Spot routing separate from perp symbols such as `BTC`.

## Route Family

| Data family   | REST path pattern                                    | Use                                       |
| ------------- | ---------------------------------------------------- | ----------------------------------------- |
| Pairs         | `/v1/hyperliquid/spot/pairs`                         | Discover supported Spot pairs             |
| Pair metadata | `/v1/hyperliquid/spot/pairs/{symbol}`                | Inspect one Spot pair                     |
| Order book    | `/v1/hyperliquid/spot/orderbook/{symbol}`            | Pull current Spot depth                   |
| Trades        | `/v1/hyperliquid/spot/trades/{symbol}`               | Pull bounded historical trades            |
| Candles       | `/v1/hyperliquid/spot/candles/{symbol}`              | Pull OHLCV candles for pair-level history |
| L4 checkpoint | `/v1/hyperliquid/spot/orderbook/{symbol}/l4`         | Start reconstruction from a checkpoint    |
| L4 diffs      | `/v1/hyperliquid/spot/orderbook/{symbol}/l4/diffs`   | Apply book diffs over time                |
| L4 history    | `/v1/hyperliquid/spot/orderbook/{symbol}/l4/history` | Pull historical reconstruction windows    |
| Order history | `/v1/hyperliquid/spot/orders/{symbol}/history`       | Inspect historical Spot order flow        |
| TWAP          | `/v1/hyperliquid/spot/twap/{symbol}`                 | Query symbol-level TWAP surfaces          |
| User TWAP     | `/v1/hyperliquid/spot/twap/user/{user}`              | Query user-scoped TWAP surfaces           |
| Freshness     | `/v1/hyperliquid/spot/freshness/{symbol}`            | Gate downstream jobs on freshness         |

## Example

<CodeGroup>
  ```bash curl theme={"theme":"github-dark"}
  curl "https://api.0xarchive.io/v1/hyperliquid/spot/orderbook/HYPE-USDC?depth=10" \
    -H "X-API-Key: $OXARCHIVE_API_KEY"
  ```

  ```python Python theme={"theme":"github-dark"}
  import os
  import requests

  resp = requests.get(
      "https://api.0xarchive.io/v1/hyperliquid/spot/trades/HYPE-USDC",
      headers={"X-API-Key": os.environ["OXARCHIVE_API_KEY"]},
      params={"limit": 50},
      timeout=30,
  )
  resp.raise_for_status()
  payload = resp.json()
  print(payload["meta"]["request_id"])
  ```
</CodeGroup>

## Implementation Notes

<AccordionGroup>
  <Accordion title="Use Spot pair symbols">
    Spot examples use pair symbols such as `HYPE-USDC`. Do not route Spot jobs through core perp symbols, HIP-3 namespaced symbols, or HIP-4 outcome IDs.
  </Accordion>

  <Accordion title="Gate reconstruction jobs">
    For L4 work, start with a checkpoint route, apply diffs in order, and keep the request ID in logs when a checkpoint is not available for the requested timestamp.
  </Accordion>

  <Accordion title="Check freshness before automation">
    Use the freshness route before alerting, trading research, exports, or model input jobs depend on Spot results.
  </Accordion>
</AccordionGroup>

## Spot Request Packet

Use this packet before a Spot route enters application code, a generated client, or an agent workflow.

| Field                 | Spot-family value                                                                       |
| --------------------- | --------------------------------------------------------------------------------------- |
| Namespace             | `/v1/hyperliquid/spot/*`                                                                |
| Symbol style          | Pair symbols such as `HYPE-USDC`                                                        |
| First probe           | Pair metadata, order book, trades page, candles page, or freshness route                |
| Reconstruction inputs | L4 checkpoint, diffs, history window, and request IDs when order-level behavior matters |
| Do not mix with       | Core perp symbols, HIP-3 builder prefixes, HIP-4 outcome IDs, or Lighter symbols        |

## Freshness And Empty Results

Some Spot data families can be present for the route while a specific pair or timestamp has no available checkpoint or no returned records. Treat that as normal market-data behavior, not as permission to fabricate a book. Check `/v1/hyperliquid/spot/freshness/{symbol}` before reconstruction or automation jobs and preserve the error `request_id` when a checkpoint is unavailable for the requested timestamp.

## Why 0xArchive Fits

0xArchive gives Spot builders the same operational pattern used across the rest of the portal: discover the instrument family, query the bounded data window, inspect the response envelope, and gate downstream use with freshness.

## Next Step

Open the generated reference in the REST API tab, then pair this page with [Venue Coverage](/venue-coverage), [Data Quality](/data-quality), and [Historical Market Data](/guides/historical-market-data).
