Skip to main content

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.

​
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.
  • 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
clearinghouseStatePer-user perp account: positions, margin, account value
spotClearinghouseStatePer-user spot balances
frontendOpenOrdersPer-user open orders with TP/SL trigger metadata
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
Other Info API types return {"error":"unsupported_type","type":"<the type you sent>"}. Type expansion is on the roadmap.

​
When to use which surface

NeedUse
Account state, market snapshot, open ordersInfo API (POST /info)
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 walletTxs → HypercoreFillTransaction.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. Endpoint URL - https://hypercore.goldrushdata.com/info (note: hypercore, not hyperliquid).
  2. Auth header - Authorization: Bearer <GOLDRUSH_API_KEY>. Same key as Foundational/Streaming/Pipeline.
  3. Wire-compat with Hyperliquid - request body and response are byte-for-byte identical for implemented types.
  4. HIP-3 and HIP-4 syntax - <deployer>:<symbol>-<quote> for OHLCV pairs (e.g. xyz:GOLD-USDC); plain symbol for OHLCV tokens.
  5. Streaming chain enum - HYPERCORE_MAINNET (SCREAMING_SNAKE_CASE), not hypercore-mainnet.
  6. Historical depth - HyperCore data starts at block 676,607,001 (2025-07-27T01:49:59Z); HyperEVM goes back to genesis.
  7. No rate limits on the Info API or Streaming API for HyperCore.

​
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
streaming.mdBuilding real-time features - 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