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

# Info API Overview

> A drop-in replacement for the public Hyperliquid `/info` REST API - fetch user trades (`userFills`), perp and spot account state (`clearinghouseState`), market metadata, and more with no rate limits and faster reads.

The GoldRush Hyperliquid Info API is a **drop-in replacement** for `POST https://api.hyperliquid.xyz/info`. The request body, the response shape, and the JSON keys are byte-for-byte identical to the public Hyperliquid API. The only differences are the URL and the authentication header.

Forty-nine wire-compatible `type` values are supported today across market metadata, user state, user history, vaults, and staking - plus nine GoldRush-native types (two batched state lookups, two builder-keyed fill feeds, a portfolio composite, an all-DEX metadata fan-out, and three completed-trade / PnL analytics products) with no upstream equivalent.

## Endpoint

```
POST https://hypercore.goldrushdata.com/info
Authorization: Bearer <GOLDRUSH_API_KEY>
Content-Type: application/json
```

## The most-requested reads

Most Hyperliquid apps start from the same REST calls - a user's **trades** and their **account state**. Over the drop-in `/info` API that is:

* **User trades (fills)** - [`userFills`](/docs/api-reference/hyperliquid-info/user-fills) for the latest fills, or [`userFillsByTime`](/docs/api-reference/hyperliquid-info/user-fills-by-time) for a time window (GoldRush serves these past upstream's \~10,000-fill retention limit).
* **Perp account state** - [`clearinghouseState`](/docs/api-reference/hyperliquid-info/clearinghouse-state) for a single wallet, or [`batchClearinghouseState`](/docs/api-reference/hyperliquid-info/batch-clearinghouse-state) for up to 50 wallets in one request.
* **Spot balances** - [`spotClearinghouseState`](/docs/api-reference/hyperliquid-info/spot-clearinghouse-state), or [`batchSpotClearinghouseState`](/docs/api-reference/hyperliquid-info/batch-spot-clearinghouse-state) for many wallets at once.

Every type below is called the same way - `POST /info` with a `type` field - so these are the same requests you already make against `api.hyperliquid.xyz`, pointed at a faster, unthrottled host.

## Comparison with the public Hyperliquid API

|                          | Public API                                                                                               | GoldRush                                                                      |
| ------------------------ | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| URL                      | `https://api.hyperliquid.xyz/info`                                                                       | `https://hypercore.goldrushdata.com/info`                                     |
| Auth                     | None                                                                                                     | `Authorization: Bearer <key>`                                                 |
| Rate limit               | 1200 weight/min/IP                                                                                       | None                                                                          |
| Orderbook latency target | `p50`: `~280 ms`                                                                                         | `p50`: `<150 ms`                                                              |
| Wire compatibility       | n/a (it's the source)                                                                                    | Byte-for-byte                                                                 |
| Available types          | See [Hyperliquid Docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint) | See [Available types](#available-types)                                       |
| Types not in public API  | n/a                                                                                                      | Batched user state, builder fills, liquidation feed, composites               |
| Unsupported types        | n/a                                                                                                      | Return `{"error":"unsupported_type","type":"<x>"}` instead of being forwarded |

## Available types

The Info API supports the wire-compatible drop-in types below, organized by what they return. Nine GoldRush-native types (`batchClearinghouseState`, `batchSpotClearinghouseState`, `builderFills`, `builderFillsByTime`, `portfolioState`, `allPerpMetas`, `userCompletedTrades`, `userCompletedTradesByTime`, `userPnlSummary`) have no upstream Hyperliquid equivalent.

### Market metadata

| Type                                                                                    | Body                                                                                   | Returns                                                                                                                                               |
| --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`metaAndAssetCtxs`](/docs/api-reference/hyperliquid-info/meta-and-asset-ctxs)               | `{"type": "metaAndAssetCtxs", "dex": ""}`                                              | Tuple `[meta, assetCtxs[]]` - perp universe + per-asset live mark price, funding, OI, day volume.                                                     |
| [`meta`](/docs/api-reference/hyperliquid-info/meta)                                          | `{"type": "meta", "dex": ""}`                                                          | Perp universe metadata only - size decimals, max leverage, margin tiers. No live context.                                                             |
| [`spotMetaAndAssetCtxs`](/docs/api-reference/hyperliquid-info/spot-meta-and-asset-ctxs)      | `{"type": "spotMetaAndAssetCtxs"}`                                                     | Tuple `[spotMeta, assetCtxs[]]` - spot universe + per-pair live mark price, mid, day volume.                                                          |
| [`spotMeta`](/docs/api-reference/hyperliquid-info/spot-meta)                                 | `{"type": "spotMeta"}`                                                                 | Spot universe metadata only - pairs and the full token registry. No live context.                                                                     |
| [`outcomeMeta`](/docs/api-reference/hyperliquid-info/outcome-meta)                           | `{"type": "outcomeMeta"}`                                                              | Active HIP-4 outcome universe - integer outcome IDs, names, structured descriptions, and `sideSpecs` (`Yes` / `No`).                                  |
| [`settledOutcome`](/docs/api-reference/hyperliquid-info/settled-outcome)                     | `{"type": "settledOutcome", "outcome": 1}`                                             | Resolution data for a settled HIP-4 outcome - the original `spec`, `settleFraction` paid to `Yes`, and `details` describing how the outcome resolved. |
| [`l2Book`](/docs/api-reference/hyperliquid-info/l2-book)                                     | `{"type": "l2Book", "coin": "BTC"}`                                                    | Aggregated Level-2 order book snapshot for one coin - bids and asks as `{px, sz, n}` levels.                                                          |
| [`candleSnapshot`](/docs/api-reference/hyperliquid-info/candle-snapshot)                     | `{"type": "candleSnapshot", "req": {"coin": "BTC", "interval": "1h", "startTime": …}}` | Historical OHLCV candles for a coin and interval over a time window.                                                                                  |
| [`fundingHistory`](/docs/api-reference/hyperliquid-info/funding-history)                     | `{"type": "fundingHistory", "coin": "BTC", "startTime": …}`                            | Market-wide historical funding rates and premiums for a coin over a time window.                                                                      |
| [`perpDexs`](/docs/api-reference/hyperliquid-info/perp-dexs)                                 | `{"type": "perpDexs"}`                                                                 | List of HIP-3 builder-deployed perp DEXes (index `0` = canonical Hyperliquid; each entry has `name`, `full_name`, `deployer`, `oracle_updater`).      |
| [`allPerpMetas`](/docs/api-reference/hyperliquid-info/all-perp-metas)                        | `{"type": "allPerpMetas"}`                                                             | Universe + margin tables for **every** perp DEX in one array (index `0` = native, then HIP-3 DEXes in `perpDexs` order). **GoldRush-native**.         |
| [`allMids`](/docs/api-reference/hyperliquid-info/all-mids)                                   | `{"type": "allMids", "dex": ""}`                                                       | Current mid price for every actively traded coin, as a `coin → price` map (spot pairs keyed `@index`).                                                |
| [`perpDexLimits`](/docs/api-reference/hyperliquid-info/perp-dex-limits)                      | `{"type": "perpDexLimits", "dex": "xyz"}`                                              | Per-DEX open-interest, position-size, and transfer limits for a HIP-3 perp DEX.                                                                       |
| [`marginTable`](/docs/api-reference/hyperliquid-info/margin-table)                           | `{"type": "marginTable", "id": 56}`                                                    | Margin-tier (leverage-bracket) table for a `marginTableId`.                                                                                           |
| [`maxMarketOrderNtls`](/docs/api-reference/hyperliquid-info/max-market-order-ntls)           | `{"type": "maxMarketOrderNtls"}`                                                       | Maximum market-order notional for each leverage bucket.                                                                                               |
| [`perpsAtOpenInterestCap`](/docs/api-reference/hyperliquid-info/perps-at-open-interest-cap)  | `{"type": "perpsAtOpenInterestCap"}`                                                   | List of perp coins currently at their open-interest cap.                                                                                              |
| [`exchangeStatus`](/docs/api-reference/hyperliquid-info/exchange-status)                     | `{"type": "exchangeStatus"}`                                                           | Current exchange operational status and server time.                                                                                                  |
| [`validatorL1Votes`](/docs/api-reference/hyperliquid-info/validator-l1-votes)                | `{"type": "validatorL1Votes"}`                                                         | Pending validator L1 governance votes/actions.                                                                                                        |
| [`spotDeployState`](/docs/api-reference/hyperliquid-info/spot-deploy-state)                  | `{"type": "spotDeployState", "user": "0x…"}`                                           | Spot-token deployment state and gas auction for a deployer.                                                                                           |
| [`perpDeployAuctionStatus`](/docs/api-reference/hyperliquid-info/perp-deploy-auction-status) | `{"type": "perpDeployAuctionStatus"}`                                                  | Current perp-deploy Dutch-auction status.                                                                                                             |
| [`liquidatable`](/docs/api-reference/hyperliquid-info/liquidatable)                          | `{"type": "liquidatable"}`                                                             | Accounts currently eligible for liquidation.                                                                                                          |

### User account state

| Type                                                                                 | Body                                                           | Returns                                                                                                                                                               |
| ------------------------------------------------------------------------------------ | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`clearinghouseState`](/docs/api-reference/hyperliquid-info/clearinghouse-state)          | `{"type": "clearinghouseState", "user": "0x…", "dex": ""}`     | Perp account: positions, margin summary, account value, withdrawable.                                                                                                 |
| [`spotClearinghouseState`](/docs/api-reference/hyperliquid-info/spot-clearinghouse-state) | `{"type": "spotClearinghouseState", "user": "0x…", "dex": ""}` | Spot balances per token, total USD value.                                                                                                                             |
| [`frontendOpenOrders`](/docs/api-reference/hyperliquid-info/frontend-open-orders)         | `{"type": "frontendOpenOrders", "user": "0x…", "dex": ""}`     | Open orders + trigger metadata (TP/SL, `isPositionTpsl`, `reduceOnly`, `orderType`).                                                                                  |
| [`activeAssetData`](/docs/api-reference/hyperliquid-info/active-asset-data)               | `{"type": "activeAssetData", "user": "0x…", "coin": "ETH"}`    | Per-user, per-asset trading state: leverage, directional max trade sizes, available-to-trade amounts, and mark price.                                                 |
| [`subAccounts`](/docs/api-reference/hyperliquid-info/sub-accounts)                        | `{"type": "subAccounts", "user": "0x…"}`                       | List of sub-accounts owned by a master, each with its inlined perp and spot state.                                                                                    |
| [`webData2`](/docs/api-reference/hyperliquid-info/web-data2)                              | `{"type": "webData2", "user": "0x…"}`                          | Composite frontend snapshot for a wallet - `clearinghouseState`, `openOrders`, perp `meta`/`assetCtxs`, `spotAssetCtxs`, TWAP and vault state in a single round-trip. |
| [`openOrders`](/docs/api-reference/hyperliquid-info/open-orders)                          | `{"type": "openOrders", "user": "0x…", "dex": ""}`             | A wallet's resting open orders (coin, side, `limitPx`, `sz`, `oid`).                                                                                                  |
| [`userRole`](/docs/api-reference/hyperliquid-info/user-role)                              | `{"type": "userRole", "user": "0x…"}`                          | Account role - `user`, `agent`, `vault`, or `subAccount` (with its master).                                                                                           |
| [`userFees`](/docs/api-reference/hyperliquid-info/user-fees)                              | `{"type": "userFees", "user": "0x…"}`                          | Fee schedule and recent daily trading volume for a wallet.                                                                                                            |
| [`userRateLimit`](/docs/api-reference/hyperliquid-info/user-rate-limit)                   | `{"type": "userRateLimit", "user": "0x…"}`                     | API rate-limit usage, cap, and cumulative volume.                                                                                                                     |
| [`userAbstraction`](/docs/api-reference/hyperliquid-info/user-abstraction)                | `{"type": "userAbstraction", "user": "0x…"}`                   | Account-abstraction mode (`"disabled"` or `"unifiedAccount"`).                                                                                                        |
| [`extraAgents`](/docs/api-reference/hyperliquid-info/extra-agents)                        | `{"type": "extraAgents", "user": "0x…"}`                       | Approved API-agent wallets, each with `name` and `validUntil`.                                                                                                        |
| [`userToMultiSigSigners`](/docs/api-reference/hyperliquid-info/user-to-multi-sig-signers) | `{"type": "userToMultiSigSigners", "user": "0x…"}`             | Authorized signers and threshold for a multi-sig account (`null` if not multi-sig).                                                                                   |
| [`maxBuilderFee`](/docs/api-reference/hyperliquid-info/max-builder-fee)                   | `{"type": "maxBuilderFee", "user": "0x…", "builder": "0x…"}`   | Maximum builder fee (tenths of a bp) a user has approved for a builder.                                                                                               |
| [`portfolioState`](/docs/api-reference/hyperliquid-info/portfolio-state)                  | `{"type": "portfolioState", "user": "0x…", "dex": ""}`         | Perp `clearinghouseState` + `spotClearinghouseState` + `userAbstraction` in one call (`dex: "ALL_DEXES"` for all DEXes). **GoldRush-native**.                         |

### User history

| Type                                                                                             | Body                                                                     | Returns                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`userFills`](/docs/api-reference/hyperliquid-info/user-fills)                                        | `{"type": "userFills", "user": "0x…"}`                                   | Most recent fills for a wallet (up to 2,000).                                                                                                                             |
| [`userFillsByTime`](/docs/api-reference/hyperliquid-info/user-fills-by-time)                          | `{"type": "userFillsByTime", "user": "0x…", "startTime": …}`             | Fills bounded by a time window.                                                                                                                                           |
| [`userCompletedTrades`](/docs/api-reference/hyperliquid-info/user-completed-trades)                   | `{"type": "userCompletedTrades", "user": "0x…"}`                         | Latest fully-closed round-trip trades for a wallet, newest-first (default 100, max 500), each with realized PnL, funding, fees, and VWAP entry/exit. **GoldRush-native**. |
| [`userCompletedTradesByTime`](/docs/api-reference/hyperliquid-info/user-completed-trades-by-time)     | `{"type": "userCompletedTradesByTime", "user": "0x…", "startTime": …}`   | Fully-closed round-trip trades over a `close_time` window, oldest-first, with a `{close_time}_{tx_index}` keyset cursor for forward paging. **GoldRush-native**.          |
| [`userPnlSummary`](/docs/api-reference/hyperliquid-info/user-pnl-summary)                             | `{"type": "userPnlSummary", "user": "0x…"}`                              | One aggregate object per wallet - net realized PnL, win/loss rate, trade count, volume, fees, funding, active days, account age, and traded pairs. **GoldRush-native**.   |
| [`userTwapSliceFills`](/docs/api-reference/hyperliquid-info/user-twap-slice-fills)                    | `{"type": "userTwapSliceFills", "user": "0x…"}`                          | Most recent TWAP slice fills, each tagged with the parent `twapId`.                                                                                                       |
| [`userTwapSliceFillsByTime`](/docs/api-reference/hyperliquid-info/user-twap-slice-fills-by-time)      | `{"type": "userTwapSliceFillsByTime", "user": "0x…", "startTime": …}`    | TWAP slice fills bounded by a time window. Served from GoldRush's historical store so windows extend past upstream's 10,000-fill retention.                               |
| [`userFunding`](/docs/api-reference/hyperliquid-info/user-funding)                                    | `{"type": "userFunding", "user": "0x…", "startTime": …}`                 | Funding payment history with rate, applied size, and USDC delta per event.                                                                                                |
| [`userNonFundingLedgerUpdates`](/docs/api-reference/hyperliquid-info/user-non-funding-ledger-updates) | `{"type": "userNonFundingLedgerUpdates", "user": "0x…", "startTime": …}` | Ledger events except funding - deposits, withdrawals, transfers, vault flows, liquidations.                                                                               |

### Vaults & staking

| Type                                                                                  | Body                                                                | Returns                                                                |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [`userVaultEquities`](/docs/api-reference/hyperliquid-info/user-vault-equities)            | `{"type": "userVaultEquities", "user": "0x…"}`                      | Per-vault locked equity with unlock timestamps.                        |
| [`delegatorSummary`](/docs/api-reference/hyperliquid-info/delegator-summary)               | `{"type": "delegatorSummary", "user": "0x…"}`                       | Current delegated, undelegated, and pending-withdrawal HYPE totals.    |
| [`delegatorHistory`](/docs/api-reference/hyperliquid-info/delegator-history)               | `{"type": "delegatorHistory", "user": "0x…"}`                       | Delegate, undelegate, deposit, and withdrawal staking events.          |
| [`delegatorRewards`](/docs/api-reference/hyperliquid-info/delegator-rewards)               | `{"type": "delegatorRewards", "user": "0x…"}`                       | Accrued staking rewards (delegation and validator commission).         |
| [`delegations`](/docs/api-reference/hyperliquid-info/delegations)                          | `{"type": "delegations", "user": "0x…"}`                            | Active HYPE staking delegations, per validator.                        |
| [`userBorrowLendInterest`](/docs/api-reference/hyperliquid-info/user-borrow-lend-interest) | `{"type": "userBorrowLendInterest", "user": "0x…", "startTime": …}` | Borrow/lend interest accrual history over a time window.               |
| [`vaultSummaries`](/docs/api-reference/hyperliquid-info/vault-summaries)                   | `{"type": "vaultSummaries"}`                                        | Summary information for every vault on the platform.                   |
| [`vaultDetails`](/docs/api-reference/hyperliquid-info/vault-details)                       | `{"type": "vaultDetails", "vaultAddress": "0x…"}`                   | Full detail for one vault - leader, portfolio history, APR, followers. |
| [`leadingVaults`](/docs/api-reference/hyperliquid-info/leading-vaults)                     | `{"type": "leadingVaults", "user": "0x…"}`                          | Vaults that a user leads.                                              |

### Builder activity

| Type                                                                          | Body                                                               | Returns                                                                                                       |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| [`builderFills`](/docs/api-reference/hyperliquid-info/builder-fills)               | `{"type": "builderFills", "builder": "0x…"}`                       | Most recent fills attributed to a builder address (up to 2,000). **GoldRush-native**, no upstream equivalent. |
| [`builderFillsByTime`](/docs/api-reference/hyperliquid-info/builder-fills-by-time) | `{"type": "builderFillsByTime", "builder": "0x…", "startTime": …}` | Builder-attributed fills bounded by a time window. **GoldRush-native**, no upstream equivalent.               |

### GoldRush-native batch

| Type                                                                                            | Body                                                                  | Returns                                                                                 |
| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [`batchClearinghouseState`](/docs/api-reference/hyperliquid-info/batch-clearinghouse-state)          | `{"type": "batchClearinghouseState", "users": ["0x…", …], "dex": ""}` | Array of `clearinghouseState` slots. **GoldRush-native**, 1 to 50 wallets per call.     |
| [`batchSpotClearinghouseState`](/docs/api-reference/hyperliquid-info/batch-spot-clearinghouse-state) | `{"type": "batchSpotClearinghouseState", "users": ["0x…", …]}`        | Array of `spotClearinghouseState` slots. **GoldRush-native**, 1 to 50 wallets per call. |

If you send a `type` that isn't in the table above, the response body is `{"error":"unsupported_type","type":"<the type you sent>"}`. Requests are not forwarded to upstream Hyperliquid.

## How clients see it

Existing Hyperliquid SDKs work unchanged after a `baseUrl` override. See [SDK compatibility](/docs/goldrush-hyperliquid/info-api/sdk-compatibility) for `nomeida/hyperliquid` (JS) and `hyperliquid-dex/hyperliquid-python-sdk` setup snippets.

## Errors

| Status | Body                                           | Cause                                                                                                                                                          |
| ------ | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `400`  | `{"error":"invalid request"}`                  | Malformed body.                                                                                                                                                |
| `400`  | `{"error":"unsupported_type","type":"<type>"}` | The `type` field isn't one of the natively-supported types.                                                                                                    |
| `401`  | `{"error":"unauthorized"}`                     | Missing or invalid `Authorization` header.                                                                                                                     |
| `429`  | n/a                                            | **Not returned.** GoldRush has no per-IP rate limit on `/info` - any retry logic you carried over from `api.hyperliquid.xyz` can stay in place but won't fire. |
| `5xx`  | Server error                                   | Internal server error.                                                                                                                                         |

## Networks

Mainnet only. Testnet support is deferred.

## Next

<CardGroup cols={2}>
  <Card title="Migration guide" icon="rotate" href="/docs/goldrush-hyperliquid/info-api/migration">
    Side-by-side examples - change one URL and one header.
  </Card>

  <Card title="SDK compatibility" icon="cube" href="/docs/goldrush-hyperliquid/info-api/sdk-compatibility">
    Drop-in setup for `nomeida/hyperliquid` and `hyperliquid-python-sdk`.
  </Card>

  <Card title="Limits and caching" icon="gauge-high" href="/docs/goldrush-hyperliquid/info-api/limits">
    No rate limits - what to know about caching and recommended polling cadences.
  </Card>

  <Card title="API reference" icon="code" href="/docs/api-reference/hyperliquid-info/meta-and-asset-ctxs">
    Per-endpoint request and response schemas.
  </Card>
</CardGroup>
