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

# Hyperliquid API Overview

> GoldRush is the complete, low-latency data infrastructure for Hyperliquid - the indexer and API provider behind a drop-in `/info` API replacement with no rate limits, real-time order book and wallet streams for HIP-3 and HIP-4 markets, and full HyperEVM coverage.

<video controls src="https://www.datocms-assets.com/86369/1781714753-goldrush-hyperliquid-data-stack_final.mp4" />

GoldRush is the **complete, low-latency data layer for Hyperliquid** - the indexer and data provider that aggregates everything you need to build on Hyperliquid - HyperCore, HIP-3, HIP-4, and HyperEVM - under one API key.

> [!NOTE]
>
> **Hyperliquid - HyperCore historical coverage starts at block `606,858,021` (`2025-05-25T14:32:53Z`).**
>
> Every data type (fill, order, trade, funding, and ledger event) from that block onward is retained and queryable.

> [card] [Drop-in Hyperliquid API replacement](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview.md)
>
> Drop-in replacement for both the public `/info` REST API and `/ws` WebSocket. Change one URL to remove rate limits and unlock more data. Hosted at `hypercore.goldrushdata.com`.

> [card] [Real-time Streaming](https://goldrush.dev/docs/goldrush-hyperliquid/streaming/wallet-firehose.md)
>
> Wallet firehose, OHLCV for every HIP-3 and HIP-4 market the moment it goes live, and pre-decoded liquidations and vault events.

> [card] [HyperEVM coverage](https://goldrush.dev/docs/chains/hyperevm.md)
>
> Token balances, transfers, approvals, NFTs, and gas for HyperEVM - same shape as every other EVM chain on GoldRush.

## Drop-in coverage: REST + WebSocket

GoldRush replaces **both** of Hyperliquid's public surfaces with a single host - `hypercore.goldrushdata.com`. Same request bodies, same response shapes, same subscription payloads as the public API. Swap the URL, add the GoldRush API key, and your existing clients work unchanged - with no rate limits and no per-IP subscription caps.

> [!NOTE]
>
> **Auth differs between REST and WebSocket.** REST takes an `Authorization: Bearer <GOLDRUSH_API_KEY>` header. The WebSocket takes a `?key=<GOLDRUSH_API_KEY>` query parameter (most WebSocket clients can't send headers during the upgrade handshake). Same key for both.

> [card] [REST /info API](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview.md)
>
> Drop-in replacement for `POST https://api.hyperliquid.xyz/info`. 17 wire-compatible `type` values plus GoldRush-native batch endpoints (`batchClearinghouseState`, `batchSpotClearinghouseState`) for up to 50 wallets per call.

> [card] [WebSocket API](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/overview.md)
>
> Drop-in replacement for `wss://api.hyperliquid.xyz/ws` with no 1000-subscription-per-IP cap. Subscribe to `l2Book` (aggregated snapshots - omit `coin` to stream **every asset** on one subscription), the GoldRush-native `l2BookDiff` (snapshot plus per-block diffs of changed `{px, sz, n}` levels - accepts a single coin, a list, or wildcard), or the GoldRush-native `l4Book` (per-order snapshot plus per-block diffs with `user`, `oid`, `cloid`, and trigger metadata exposed).

## Hyperliquid API limitations addressed by GoldRush

The public Hyperliquid `/info` API is generous, but it has hard limits that most production apps run into:

* **1200 weight/min/IP** rate limits per address.
* **1000 WebSocket subscriptions per IP** - not enough to track every active trader.
* **WebSocket subscription filters are required** - every subscription must specify an asset (e.g. `coin` on `l2Book`), forcing per-asset fan-out that burns through the 1000-subscription cap. GoldRush makes these filters **optional** so a single wildcard subscription streams every asset.
* **No batch address endpoints** - account-state calls are single-wallet only; GoldRush adds `batchClearinghouseState` and `batchSpotClearinghouseState` for up to 50 wallets per request.
* **`userFills` capped at \~10,000 rows** - active traders blow through that in weeks.
* **Liquidations buried inside fills** as a thin stub; vault, staking, and delegation data arrives untyped.
* **HIP-3 and HIP-4 discovery is manual** - `candleSnapshot` is poll-based and effectively limited to mainstream markets.
* **No HyperEVM concept at all** - DEXes, NFT mints, and lending live on chain `999` and the `/info` API doesn't see them.

GoldRush closes every one of these gaps. See [GoldRush vs Hyperliquid public API](https://goldrush.dev/docs/resources/differentiate-your-hyperliquid-app.md) for the full breakdown.

## What's included

| Surface | What you get | Where to start |
| - | - | - |
| **Hyperliquid Info API** | Drop-in replacement for `POST https://api.hyperliquid.xyz/info` with `POST https://hypercore.goldrushdata.com/info`. Same request body, no rate limits, faster orderbook reads, batched user state, builder-attribution data, and HIP-4 outcome metadata. | [Info API Overview](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview.md) |
| **Hyperliquid WebSocket API** | Drop-in replacement for `wss://api.hyperliquid.xyz/ws` with `wss://hypercore.goldrushdata.com/ws`. Same subscription payloads, no 1000-subscription-per-IP cap, and `coin` is optional on `l2Book` (stream every asset on one subscription). Adds the GoldRush-native `l2BookDiff` L2 snapshot-plus-diff stream (single coin, list of coins, or wildcard) and `l4Book` order-level diff stream with `user`, `oid`, `cloid`, and trigger metadata per order. | [WebSocket API Overview](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/overview.md) |
| **Foundational API** | HyperEVM token balances, transfers, approvals, NFTs, gas, blocks. | [HyperEVM Chain Page](https://goldrush.dev/docs/chains/hyperevm.md) |
| **Live Analytics** | HIP-3 Market Screener, Liquidation Cascade Map, Market Health Score at [hyperliquid.goldrush.dev](https://hyperliquid.goldrush.dev). | [Live Tools](https://goldrush.dev/docs/goldrush-hyperliquid/analytics-app.md) |

## Infrastructure

GoldRush runs its own Hyperliquid indexing infrastructure - purpose-built to be the fastest, most reliable Hyperliquid data provider for production apps and quant desks:

* **Dedicated Hyperliquid nodes in Tokyo** - co-located with Hyperliquid's validator infrastructure for low-latency reads.
* **Private backbone** for high-throughput data ingestion.
* **No rate limits** - bypass the public `/info` and WebSocket constraints entirely.
* **Full historical backfill** - every fill, funding payment, and ledger event back to HyperCore block `606,858,021` (`2025-05-25T14:32:53Z`). HyperEVM coverage goes back to genesis.

## Quickstart

Here are three "first 5 minutes" quickstarts. Pick whichever maps to what you are building.

> [card] [Upgrade from the public Hyperliquid API](https://goldrush.dev/docs/goldrush-hyperliquid/quickstart.md#1-drop-in-info-api)
>
> Already using `api.hyperliquid.xyz/info`? Change the URL and add one header.

> [card] [Watch wallets](https://goldrush.dev/docs/goldrush-hyperliquid/quickstart.md#2-stream-wallet-activity)
>
> Subscribe to thousands of HyperCore wallets in one connection.

> [card] [Fan out across many wallets](https://goldrush.dev/docs/goldrush-hyperliquid/quickstart.md#3-fan-out-across-many-wallets)
>
> Fetch account state for up to 50 wallets in one call.

## All Hyperliquid endpoints

Every Hyperliquid endpoint reference page, grouped by surface. The [Info API](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview.md) and [WebSocket API](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/overview.md) overviews cover each `type` in context; the full index below links straight to every endpoint's request/response schema.

### Info endpoints

* [metaAndAssetCtxs](https://goldrush.dev/docs/api-reference/hyperliquid-info/meta-and-asset-ctxs.md) — fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.
* [meta](https://goldrush.dev/docs/api-reference/hyperliquid-info/meta.md) — fetch the perpetuals universe metadata without live market context.
* [perpDexs](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-dexs.md) — enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore.
* [spotMetaAndAssetCtxs](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-meta-and-asset-ctxs.md) — fetch the spot universe metadata, token configuration, and live market data in a single call.
* [spotMeta](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-meta.md) — fetch the spot universe metadata and full token configuration without live market context.
* [outcomeMeta](https://goldrush.dev/docs/api-reference/hyperliquid-info/outcome-meta.md) — enumerate all active HIP-4 binary outcome markets on HyperCore.
* [settledOutcome](https://goldrush.dev/docs/api-reference/hyperliquid-info/settled-outcome.md) — retrieve resolution details for a settled HIP-4 binary outcome market on HyperCore.
* [l2Book](https://goldrush.dev/docs/api-reference/hyperliquid-info/l2-book.md) — fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels.
* [l2BookDiffSnapshot](https://goldrush.dev/docs/api-reference/hyperliquid-info/l2-book-diff-snapshot.md) — fetch a full-depth L2 order book snapshot for one coin, with height, epoch, and seq to bootstrap the l2BookDiff2 stream.
* [l4BookSnapshot](https://goldrush.dev/docs/api-reference/hyperliquid-info/l4-book-snapshot.md) — fetch a full order-level (L4) order book snapshot for one coin, with height, epoch, and seq to bootstrap the l4BookUpdates stream.
* [candleSnapshot](https://goldrush.dev/docs/api-reference/hyperliquid-info/candle-snapshot.md) — fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.
* [fundingHistory](https://goldrush.dev/docs/api-reference/hyperliquid-info/funding-history.md) — fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies.
* [clearinghouseState](https://goldrush.dev/docs/api-reference/hyperliquid-info/clearinghouse-state.md) — fetch a single user's perpetuals account state by wallet address.
* [spotClearinghouseState](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-clearinghouse-state.md) — fetch a single user's spot account balances by wallet address.
* [frontendOpenOrders](https://goldrush.dev/docs/api-reference/hyperliquid-info/frontend-open-orders.md) — fetch a user's currently open orders enriched with frontend metadata.
* [activeAssetData](https://goldrush.dev/docs/api-reference/hyperliquid-info/active-asset-data.md) — fetch a user's active trading limits, leverage setting, available size, and mark price for a single Hyperliquid perpetual…
* [userFills](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fills.md) — fetch a user's most recent trade fills without specifying a time window.
* [userFillsByTime](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fills-by-time.md) — fetch a user’s trade fills within a time window for P\&L recaps and tax ledger reconstruction.
* [userCompletedTrades](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-completed-trades.md) — fetch a wallet's most recent fully-closed round-trip trades, newest-first, each with realized PnL, funding, fees, and volume-weighted entry/exit prices.
* [userCompletedTradesByTime](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-completed-trades-by-time.md) — fetch a wallet's fully-closed round-trip trades within a close-time window, oldest-first, with a keyset cursor for forward paging.
* [userPnlSummary](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-pnl-summary.md) — fetch one aggregate PnL summary for a wallet - realized PnL, win/loss rate, volume, fees, funding, active days, and traded pairs.
* [userTwapSliceFills](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-twap-slice-fills.md) — fetch a user's most recent TWAP slice fills for execution-quality analytics on algorithmic orders.
* [userTwapSliceFillsByTime](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-twap-slice-fills-by-time.md) — fetch a user's TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.
* [userFunding](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-funding.md) — fetch a user's per-coin funding payment history within a time window for funding-only P\&L attribution.
* [userNonFundingLedgerUpdates](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-non-funding-ledger-updates.md) — fetch a user's non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time…
* [subAccounts](https://goldrush.dev/docs/api-reference/hyperliquid-info/sub-accounts.md) — fetch a master wallet's sub-accounts along with their full perp and spot state in a single call.
* [webData2](https://goldrush.dev/docs/api-reference/hyperliquid-info/web-data2.md) — fetch the composite snapshot the Hyperliquid web app uses for a wallet in a single call.
* [userVaultEquities](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-vault-equities.md) — fetch a user's locked vault equity positions across all vaults they have deposited into.
* [delegatorSummary](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-summary.md) — get a one-shot snapshot of a user's HYPE staking position for dashboards and portfolio overviews.
* [delegatorHistory](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-history.md) — reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary.
* [delegatorRewards](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-rewards.md) — fetch a user’s current HYPE staking position.
* [builderFills](https://goldrush.dev/docs/api-reference/hyperliquid-info/builder-fills.md) — fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics.
* [builderFillsByTime](https://goldrush.dev/docs/api-reference/hyperliquid-info/builder-fills-by-time.md) — fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting.
* [allMids](https://goldrush.dev/docs/api-reference/hyperliquid-info/all-mids.md) — fetch the current mid price for every actively traded asset in a single call.
* [perpDexLimits](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-dex-limits.md) — fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.
* [marginTable](https://goldrush.dev/docs/api-reference/hyperliquid-info/margin-table.md) — fetch the margin-tier (leverage-bracket) table for a given margin table id.
* [maxMarketOrderNtls](https://goldrush.dev/docs/api-reference/hyperliquid-info/max-market-order-ntls.md) — fetch the maximum market-order notional for each leverage bucket.
* [perpsAtOpenInterestCap](https://goldrush.dev/docs/api-reference/hyperliquid-info/perps-at-open-interest-cap.md) — list the perp assets currently at their open-interest cap.
* [openOrders](https://goldrush.dev/docs/api-reference/hyperliquid-info/open-orders.md) — list a user's resting open orders.
* [historicalOrders](https://goldrush.dev/docs/api-reference/hyperliquid-info/historical-orders.md) — fetch a user's recent orders - both open and finalized - each with its current status and status timestamp.
* [orderStatus](https://goldrush.dev/docs/api-reference/hyperliquid-info/order-status.md) — look up the status of a single order for a user, by order id (oid) or client order id (cloid).
* [userRole](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-role.md) — fetch a user's account role.
* [userFees](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fees.md) — fetch a user's fee schedule and recent daily volume.
* [userRateLimit](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-rate-limit.md) — fetch a user's API rate-limit usage and cap.
* [userAbstraction](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-abstraction.md) — fetch a user's account-abstraction mode.
* [extraAgents](https://goldrush.dev/docs/api-reference/hyperliquid-info/extra-agents.md) — list a user's approved API-agent wallets.
* [userToMultiSigSigners](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-to-multi-sig-signers.md) — fetch the authorized signers for a multi-sig user.
* [maxBuilderFee](https://goldrush.dev/docs/api-reference/hyperliquid-info/max-builder-fee.md) — fetch the maximum builder fee a user has approved for a given builder.
* [delegations](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegations.md) — list a user's active HYPE staking delegations.
* [userBorrowLendInterest](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-borrow-lend-interest.md) — fetch a user's borrow/lend interest accrual history.
* [borrowLendUserState](https://goldrush.dev/docs/api-reference/hyperliquid-info/borrow-lend-user-state.md) — monitor a wallet’s current borrow/lend positions and liquidation risk (account health) in a single call.
* [vaultSummaries](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-summaries.md) — list summary information for every vault on the platform.
* [vaultDetails](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-details.md) — fetch detailed information for a specific vault.
* [leadingVaults](https://goldrush.dev/docs/api-reference/hyperliquid-info/leading-vaults.md) — list the vaults a user leads.
* [spotDeployState](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-deploy-state.md) — fetch the spot-token deployment state and gas auction for a deployer.
* [perpDeployAuctionStatus](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-deploy-auction-status.md) — fetch the current perp-deploy Dutch-auction status.
* [exchangeStatus](https://goldrush.dev/docs/api-reference/hyperliquid-info/exchange-status.md) — fetch the current exchange operational status.
* [validatorL1Votes](https://goldrush.dev/docs/api-reference/hyperliquid-info/validator-l1-votes.md) — validatorL1Votes endpoint.
* [liquidatable](https://goldrush.dev/docs/api-reference/hyperliquid-info/liquidatable.md) — list accounts currently eligible for liquidation.
* [allPerpMetas](https://goldrush.dev/docs/api-reference/hyperliquid-info/all-perp-metas.md) — fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.
* [portfolioState](https://goldrush.dev/docs/api-reference/hyperliquid-info/portfolio-state.md) — fetch a wallet's perp clearinghouse state, spot balances, and account-abstraction mode in a single request.
* [batchClearinghouseState](https://goldrush.dev/docs/api-reference/hyperliquid-info/batch-clearinghouse-state.md) — fetch perpetuals account state for up to 50 wallets in a single request.
* [batchSpotClearinghouseState](https://goldrush.dev/docs/api-reference/hyperliquid-info/batch-spot-clearinghouse-state.md) — fetch spot account balances for up to 50 wallets in a single request.

### WebSocket endpoints

* [l2Book](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l2-book.md) — subscribe to real-time L2 order book snapshots for all Hyperliquid assets over WebSocket.
* [l2BookDiff](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l2-book-diff.md) — subscribe to real-time L2 order book (initial snapshot + diffs) for all Hyperliquid assets over WebSocket.
* [l2BookDiff2](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l2-book-diff2.md) — subscribe to a diff-only L2 order book stream with per-coin sequence numbers and a server epoch for gap detection.
* [l4Book](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l4-book.md) — subscribe to GoldRush's order-level Hyperliquid book - initial snapshot of every resting order plus per-block diffs with full metadata.
* [l4BookUpdates](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l4-book-updates.md) — subscribe to a strictly-ordered, diff-only order-level (L4) book stream with per-coin sequence numbers and a server epoch for gap detection.
* [userFills](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/user-fills.md) — stream real-time trade fills for one or more wallets as they execute on HyperCore.
* [orderUpdates](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/order-updates.md) — stream real-time order lifecycle events (placements, fills, cancels, and rejections) for one or more wallets on HyperCore.
* [liquidationFills](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/liquidation-fills.md) — stream a global, market-wide feed of every liquidation fill on HyperCore.
* [allFills](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/all-fills.md) — stream every fill on HyperCore in real time for global market analytics and cross-wallet order-flow monitoring.
* [builderFills](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/builder-fills.md) — stream live attributed fills for one or more builder addresses in real time.
* [builderLiquidations](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/builder-liquidations.md) — subscribe to real-time liquidation fills of your users.
* [userNonFundingLedgerUpdates](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/user-non-funding-ledger-updates.md) — stream real-time non-funding ledger events (deposits, withdrawals, vault and staking activity) for one or more…


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