# REST API

> HyperCore private-preview documentation.

> For the complete documentation index, see [llms.txt](/docs/llms.txt).

<Callout intent="info">
  This API is in private preview. Target October 2026; timing is subject to change.
</Callout>


# REST API

## Interfaces

The REST reference provides native-compatible reads through `POST /{apiKey}/info` and purpose-built POST routes at `https://api.g.alchemy.com/hypercore/v1`.

<Note>

A subset of the `/info` reads documented here is served today at
`https://hyperliquid-mainnet.g.alchemy.com/v2/{apiKey}/info`. Each request-type
page identifies whether it is available now or coming with HyperCore. The HyperCore
REST host is the target for the remaining reads at general availability.

</Note>

### Native `/info` conventions

Time-range responses return at most 500 elements or distinct blocks of data. For a
larger range, use the last returned timestamp as the next `startTime`.

For perpetuals, `coin` is the name returned by `meta`. For spot, use `PURR/USDC`
for PURR and `@{index}` for other pairs, where `index` is the pair index in
`spotMeta.universe`.

Pass the actual master or sub-account address when querying account data. An agent
wallet address returns an empty result.

For deployment context, see [Deploying Hyperliquid markets](/docs/chains/deploying-markets).

## Read paths

Every read other than the seven routes below uses `POST /{apiKey}/info` with a
`type` discriminator. The resource-family pages in this reference document each
request body and response contract.

The generated endpoint block documents callable HTTP routes and their request and response schemas. The resource-family sections document the `POST /{apiKey}/info` request types.

| Purpose-built route                    | Corresponding read           |
| -------------------------------------- | ---------------------------- |
| `POST /{apiKey}/user-fills`            | `userFills`                  |
| `POST /{apiKey}/user-fills-by-time`    | `userFillsByTime`            |
| `POST /{apiKey}/clearinghouse-state`   | `clearinghouseState`         |
| `POST /{apiKey}/historical-orders`     | `historicalOrders`           |
| `POST /{apiKey}/portfolio-state`       | Enriched portfolio composite |
| `POST /{apiKey}/extra-agents`          | Native `extraAgents` read (purpose-built route) |
| `POST /{apiKey}/l2-book-diff-snapshot` | L2 diff bootstrap snapshot   |