Skip to main content

GoldRush Hyperliquid API

The complete data layer for Hyperliquid. One API key unlocks:
  • Info API - drop-in replacement for POST api.hyperliquid.xyz/info at hypercore.goldrushdata.com/info. No rate limits. Same request body, same response shape.
  • WebSocket API - drop-in replacement for wss://api.hyperliquid.xyz/ws at wss://hypercore.goldrushdata.com/ws?key=<KEY>. No 1000-subscription-per-IP cap. l2Book (wildcard coin) and the GoldRush-native l4Book order-level diff stream.
  • Streaming API - walletTxs for the wallet firehose, ohlcvCandlesForPair/ohlcvCandlesForToken for HIP-3 and HIP-4 OHLCV with deployer-prefix syntax.
  • Pipeline API - hl_fills, hl_trades, hl_orders, hl_funding, hl_misc_events to ClickHouse, BigQuery, Postgres, Kafka, S3.
  • Foundational API - HyperEVM token balances, transfers, approvals, NFTs, gas.

Drop-in Info API

// Before
fetch("https://api.hyperliquid.xyz/info", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ type: "clearinghouseState", user: "0x...", dex: "" }),
});

// After - same body, no rate limits
fetch("https://hypercore.goldrushdata.com/info", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.GOLDRUSH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ type: "clearinghouseState", user: "0x...", dex: "" }),
});
That’s it. Existing SDKs (nomeida/hyperliquid for JS, hyperliquid-python-sdk for Python) work after a baseUrl override.

Available Info API types (today)

TypeUse
metaAndAssetCtxsPerp universe + per-asset live mark price, funding, OI, day volume
metaPerp universe metadata only - size decimals, max leverage, margin tiers (no live context)
spotMetaAndAssetCtxsSpot universe + per-pair live mark price, mid, day volume
spotMetaSpot universe metadata only - pairs and the full token registry (no live context)
outcomeMetaActive HIP-4 outcome universe with outcome IDs, descriptions, and Yes/No side specs
settledOutcomeResolution data for a settled HIP-4 outcome - original spec, settleFraction paid to Yes, and details describing how it resolved
l2BookAggregated Level-2 order book snapshot for one coin ({px, sz, n} bid/ask levels)
candleSnapshotHistorical OHLCV candles for a coin and interval over a time window
fundingHistoryMarket-wide historical funding rates and premiums for a coin over a time window
clearinghouseStatePer-user perp account: positions, margin, account value
spotClearinghouseStatePer-user spot balances
frontendOpenOrdersPer-user open orders with TP/SL trigger metadata
subAccountsSub-accounts owned by a master, each with inlined perp and spot state
webData2Composite frontend snapshot for a wallet - clearinghouse state, open orders, perp meta/asset contexts, spot asset contexts, TWAP and vault state in one round-trip
userFillsMost recent fills for a user
userFillsByTimeFills bounded by a time window
userTwapSliceFillsMost recent TWAP slice fills tagged with the parent twapId
userTwapSliceFillsByTimeTWAP slice fills bounded by a time window. Served from GoldRush’s historical store so windows extend past upstream’s 10,000-fill retention
userFundingFunding payment history with rate, applied size, USDC delta
userNonFundingLedgerUpdatesLedger events except funding - deposits, withdrawals, transfers, vault flows, liquidations
userVaultEquitiesPer-vault locked equity with unlock timestamps
delegatorSummaryCurrent delegated, undelegated, and pending-withdrawal HYPE totals
delegatorHistoryDelegate, undelegate, deposit, and withdrawal staking events
delegatorRewardsAccrued staking rewards (delegation and validator commission)
batchClearinghouseStatePerp account state for 1-50 wallets in one request. GoldRush-native, no upstream equivalent
batchSpotClearinghouseStateSpot balances for 1-50 wallets in one request. GoldRush-native, no upstream equivalent
builderFillsMost recent fills attributed to a builder address (up to 2,000) for revenue attribution and order-flow analytics. GoldRush-native, no upstream equivalent
builderFillsByTimeBuilder-attributed fills bounded by a time window for revenue attribution and fee accounting. GoldRush-native, no upstream equivalent
Any other type value returns {"error":"unsupported_type","type":"<the type you sent>"}. Type expansion is on the roadmap.

Available WebSocket subscriptions (today)

ChannelUse
l2BookAggregated {px, sz, n} order book per tick. coin is optional - omit to stream every asset on one subscription. Drop-in for wss://api.hyperliquid.xyz/ws l2Book, no per-IP cap.
l2BookDiffInitial L2 Snapshot per coin plus per-block Updates carrying only changed {px, sz, n} levels. coin accepts a single asset, an array, or wildcard. GoldRush-native, no upstream equivalent.
l4BookOrder-level snapshot of every resting order plus per-block diffs (order_statuses + book_diffs). Exposes user, oid, cloid, tif, triggerCondition. coin is required. GoldRush-native, no upstream equivalent.
userFillsLive trade fills for one or more wallets, batched per block as [address, fill] tuples. Aliases user / users accepted.
orderUpdatesLive order lifecycle events (placements, fills, cancels, rejections) for one or more wallets, batched per block as an updates array tagged with the originating user.
liquidationFillsGlobal stream of every liquidation fill on HyperCore. Same shape as userFills with a non-null liquidation object on every entry. GoldRush-native, no upstream equivalent.
allFillsGlobal stream of every fill on HyperCore in real time. Optional coin filter narrows to a single market. Same per-fill shape as userFills. GoldRush-native, no upstream equivalent.
builderFillsLive attributed fills for one or more builder addresses, with builder and builderFee on every entry. Pass builder (single) or addresses (array). GoldRush-native, no upstream equivalent.
userNonFundingLedgerUpdatesLive non-funding ledger events (deposits, withdrawals, transfers, liquidations, vault actions, staking, rewards) for one or more wallets.

When to use which surface

NeedUse
Account state, market snapshot, open ordersInfo API (POST /info)
Live order book - aggregated price levels, wildcard across all assetsWebSocket API l2Book on wss://hypercore.goldrushdata.com/ws
Live order book - per-order detail, queue position, per-user flow attributionWebSocket API l4Book (snapshot + per-block diffs, GoldRush-native)
Real-time wallet activity (1 → 10,000 wallets)Streaming API walletTxs
HIP-3 and HIP-4 OHLCV candlesStreaming API ohlcvCandlesForPair with xyz:GOLD-USDC syntax
Pre-decoded liquidations and vault eventsStreaming API walletTxsHypercoreFillTransaction.liquidation, HypercoreLedgerEvent
Land Hyperliquid data in your warehousePipeline API HyperCore normalizer
HyperEVM (chain 999) token balances/transfers/NFTsFoundational API on hyperevm-mainnet

Critical rules

  1. Info API endpoint URL - https://hypercore.goldrushdata.com/info (note: hypercore, not hyperliquid).
  2. Info API auth header - Authorization: Bearer <GOLDRUSH_API_KEY>. Same key as Foundational/Streaming/Pipeline.
  3. WebSocket API endpoint URL - wss://hypercore.goldrushdata.com/ws?key=<GOLDRUSH_API_KEY>. Auth is a ?key= query parameter at connect time; no Authorization header is sent. Same key as the Info API.
  4. Wire-compat with Hyperliquid - Info API request body and WebSocket subscription payloads are byte-for-byte identical to the public Hyperliquid endpoints for implemented types/channels.
  5. l4Book is GoldRush-only - it does not exist on wss://api.hyperliquid.xyz/ws. coin is required; l2Book’s coin is optional (wildcard streams every asset).
  6. HIP-3 and HIP-4 syntax - <deployer>:<symbol>-<quote> for OHLCV pairs (e.g. xyz:GOLD-USDC); plain symbol for OHLCV tokens.
  7. Streaming chain enum - HYPERCORE_MAINNET (SCREAMING_SNAKE_CASE), not hypercore-mainnet.
  8. Historical depth - HyperCore data starts at block 606,858,021 (2025-05-25T14:32:53Z); HyperEVM goes back to genesis.
  9. No rate limits on the Info API, WebSocket API, or Streaming API for HyperCore. No 1000-subscription-per-IP cap on the WebSocket API.

Reference Files

FileWhen to read
overview.mdNeed full product overview, infrastructure details, or what’s available across all surfaces
info-api.mdBuilding against the POST /info endpoint - migration, SDK overrides, per-endpoint reference
websocket-api.mdBuilding against wss://hypercore.goldrushdata.com/ws - l2Book aggregated snapshots, l4Book order-level diffs, per-endpoint reference and recipes
streaming.mdBuilding real-time features over the GraphQL Streaming API - wallet firehose, HIP-3 and HIP-4 OHLCV, liquidations and vault events
roadmap.mdWhat’s shipping next - type expansion, time-travel, cross-venue, signed responses