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

• 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: "" }),
});

​

Available Info API types (today)

​

Available WebSocket subscriptions (today)

​

When to use which surface

​

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 676,607,001 (2025-07-27T01:49:59Z); 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