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

export const HypercoreCoverageInline = () => <>
    block <code>{HYPERCORE_START_BLOCK}</code> (<code>{HYPERCORE_START_TIMESTAMP}</code>)
  </>;

<video controls className="w-full aspect-video rounded-xl" 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.

<Info>
  **Hyperliquid - HyperCore historical coverage starts at <HypercoreCoverageInline />.**

  Every data type (fill, order, trade, funding, and ledger event) from that block onward is retained and queryable.
</Info>

<CardGroup cols={2}>
  <Card title="Drop-in Hyperliquid API replacement" icon="bolt" href="/docs/goldrush-hyperliquid/info-api/overview">
    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>

  <Card title="Real-time Streaming" icon="tower-broadcast" href="/docs/goldrush-hyperliquid/streaming/wallet-firehose">
    Wallet firehose, OHLCV for every HIP-3 and HIP-4 market the moment it goes live, and pre-decoded liquidations and vault events.
  </Card>

  <Card title="HyperEVM coverage" icon="link" href="/docs/chains/hyperevm">
    Token balances, transfers, approvals, NFTs, and gas for HyperEVM - same shape as every other EVM chain on GoldRush.
  </Card>
</CardGroup>

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

<Info>
  **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.
</Info>

<CardGroup cols={2}>
  <Card title="REST /info API" icon="server" href="/docs/goldrush-hyperliquid/info-api/overview">
    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>

  <Card title="WebSocket API" icon="bolt-lightning" href="/docs/goldrush-hyperliquid/websocket-api/overview">
    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).
  </Card>
</CardGroup>

## 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](/docs/resources/differentiate-your-hyperliquid-app) 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](/docs/goldrush-hyperliquid/info-api/overview)           |
| **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](/docs/goldrush-hyperliquid/websocket-api/overview) |
| **Foundational API**          | HyperEVM token balances, transfers, approvals, NFTs, gas, blocks.                                                                                                                                                                                                                                                                                                                                                                                           | [HyperEVM Chain Page](/docs/chains/hyperevm)                                |
| **Live Analytics**            | HIP-3 Market Screener, Liquidation Cascade Map, Market Health Score at [hyperliquid.goldrush.dev](https://hyperliquid.goldrush.dev).                                                                                                                                                                                                                                                                                                                        | [Live Tools](/docs/goldrush-hyperliquid/analytics-app)                      |

## 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 <HypercoreCoverageInline />. HyperEVM coverage goes back to genesis.

## Quickstart

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

<CardGroup cols={3}>
  <Card title="Upgrade from the public Hyperliquid API" icon="rotate" href="/docs/goldrush-hyperliquid/quickstart#1-drop-in-info-api">
    Already using `api.hyperliquid.xyz/info`? Change the URL and add one header.
  </Card>

  <Card title="Watch wallets" icon="signal-stream" href="/docs/goldrush-hyperliquid/quickstart#2-stream-wallet-activity">
    Subscribe to thousands of HyperCore wallets in one connection.
  </Card>

  <Card title="Pipe orderbook fills into your warehouse" icon="warehouse" href="/docs/goldrush-hyperliquid/quickstart#3-pipe-fills-to-your-warehouse">
    Stream `hl_fills` into ClickHouse, BigQuery, or Postgres.
  </Card>
</CardGroup>

## All Hyperliquid endpoints

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

### Info endpoints

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

### WebSocket endpoints

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