> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Hyperliquid

> Query Hyperliquid account, market, order, and orderbook data through Allium's rate-limit-free proxy.

Five tools front Allium's Hyperliquid proxy. They mirror Hyperliquid's own `info` API surface but run through Allium's infrastructure, so you aren't subject to Hyperliquid's per-IP rate limits.

## Available tools

| Tool                          | Description                                                 |
| :---------------------------- | :---------------------------------------------------------- |
| `realtime_info`               | Account, market, and exchange information by request `type` |
| `realtime_fills`              | Fills for a user address                                    |
| `realtime_order_history`      | Order history for a user address                            |
| `realtime_order_status`       | Status of one order by `oid`                                |
| `realtime_orderbook_snapshot` | Complete orderbook snapshot for all pairs                   |

<Info>
  These tools carry the `realtime_` prefix because they share the Realtime API surface, but they only cover Hyperliquid. For Hyperliquid's on-chain historical data, query the [Hyperliquid schemas](/historical-data/supported-blockchains/hyperliquid/overview) with SQL instead.
</Info>

## The general-purpose tool

`realtime_info` is the catch-all: `type` selects which Hyperliquid info request to make, and the other fields depend on that type.

```json theme={null}
{
  "name": "realtime_info",
  "arguments": {
    "type": "clearinghouseState",
    "user": "0x0000000000000000000000000000000000000000"
  }
}
```

Before using it, read the full list of supported request types:

```json theme={null}
{
  "name": "browse_docs",
  "arguments": { "path": "api/developer/hyperliquid/info.md" }
}
```

## The specialized tools

Three tools cover the request types you'll reach for most, with explicit schemas.

<Tabs>
  <Tab title="Fills">
    ```json theme={null}
    {
      "name": "realtime_fills",
      "arguments": {
        "type": "userFillsByTime",
        "user": "0x0000000000000000000000000000000000000000",
        "startTime": 1767225600000,
        "endTime": 1769904000000,
        "aggregateByTime": true
      }
    }
    ```

    `type` and `user` are required. Timestamps are Hyperliquid-style epoch milliseconds.

    `startTime` and `endTime` only apply when `type` is `userFillsByTime` — with `type: "userFills"` they're ignored. `aggregateByTime` and `twapMode` apply to both.
  </Tab>

  <Tab title="Order history">
    ```json theme={null}
    {
      "name": "realtime_order_history",
      "arguments": {
        "type": "historicalOrders",
        "user": "0x0000000000000000000000000000000000000000",
        "startTime": 1767225600000
      }
    }
    ```
  </Tab>

  <Tab title="Order status">
    ```json theme={null}
    {
      "name": "realtime_order_status",
      "arguments": {
        "type": "orderStatus",
        "user": "0x0000000000000000000000000000000000000000",
        "oid": 123456789
      }
    }
    ```

    All three fields are required.
  </Tab>
</Tabs>

## Orderbook snapshot

Takes no arguments and returns every pair at once.

```json theme={null}
{ "name": "realtime_orderbook_snapshot", "arguments": {} }
```

<Warning>
  This is a full snapshot across all pairs and can be large. Have your agent filter to the pairs it needs rather than holding the whole payload in context.
</Warning>

## Documentation paths

Each tool's description carries its `browse_docs` path — the authoritative reference for parameters and response shape.

| Tool                          | Docs path                                         |
| :---------------------------- | :------------------------------------------------ |
| `realtime_info`               | `api/developer/hyperliquid/info.md`               |
| `realtime_fills`              | `api/developer/hyperliquid/fills.md`              |
| `realtime_order_history`      | `api/developer/hyperliquid/order-history.md`      |
| `realtime_order_status`       | `api/developer/hyperliquid/order-status.md`       |
| `realtime_orderbook_snapshot` | `api/developer/hyperliquid/orderbook-snapshot.md` |

## Related resources

<CardGroup cols={2}>
  <Card title="Hyperliquid API" icon="bolt" href="/api/developer/hyperliquid/overview">
    The REST endpoints behind these tools
  </Card>

  <Card title="Hyperliquid data" icon="database" href="/historical-data/supported-blockchains/hyperliquid/overview">
    Historical Hyperliquid schemas for SQL
  </Card>

  <Card title="Realtime data" icon="bolt" href="/ai/mcp/tools-reference/realtime">
    Prices, balances, holdings, and tokens
  </Card>

  <Card title="Billing & limits" icon="receipt" href="/ai/mcp/tools-reference/billing-and-limits">
    These tools consume Developer Units
  </Card>
</CardGroup>