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.

Credit Cost

0.5 per coin per minute

Processing

Realtime
  • Wire-compatible with wss://api.hyperliquid.xyz/ws l2Book subscriptions - same channel name, same levels shape.
  • coin is optional on GoldRush. Omit it to stream the entire L2 order book across every asset on a single subscription. The public Hyperliquid API requires coin and locks each subscription to one asset at a time.
  • When coin is omitted, the optional marketTypes filter selects which market families to include. It defaults to ["perp"] only.
  • Pass "marketTypes": ["spot"], or "marketTypes":["outcome"], or a mix (e.g. "marketTypes": ["perp","spot"]), or use the wildcard "marketTypes": ["*"] to opt into spot, perps, outcome, and any future market types.
  • No 1000-subscription-per-IP cap - multiplex hundreds of l2Book subscriptions on a single connection.
  • For OHLCV candles instead of raw book state, use the Streaming API OHLCV streams.
Note: When coin is omitted, a credit rate of 50 credits per minute subscribed is applied.

​
Endpoint

wss://hypercore.goldrushdata.com/ws?key=<GOLDRUSH_API_KEY>
​
key
string
required
Your GoldRush API key. Passed as a query parameter at connection time - no Authorization header is used.

​
Subscribe

Send this JSON message after the connection is established:
​
method
string
required
Always "subscribe".
​
subscription
object
required

​
Example

Pick the subscription shape that matches the coverage you want:
Subscribe withWhat you receive
{"type":"l2Book","coin":"BTC"}L2 snapshots for BTC only
{"type":"l2Book"}L2 snapshots for every perp coin (default: marketTypes: ["perp"])
{"type":"l2Book","marketTypes":["spot"]}L2 snapshots for every spot coin
{"type":"l2Book","marketTypes":["outcome"]}L2 snapshots for every HIP-4 outcome market
{"type":"l2Book","marketTypes":["perp","spot"]}L2 snapshots for perps + spot
{"type":"l2Book","marketTypes":["*"]}L2 snapshots for every coin (perp + spot + outcome, plus future types)
wscat -c "wss://hypercore.goldrushdata.com/ws?key=$GOLDRUSH_API_KEY"

> {"method":"subscribe","subscription":{"type":"l2Book","coin":"BTC"}}

​
Unsubscribe

Send the same subscription body with method: "unsubscribe": 
{
  "method": "unsubscribe",
  "subscription": { "type": "l2Book", "coin": "BTC" }
}
Unsubscribe matches subscriptions by exact body. A subscription created with coin: ["BTC", "ETH"] is a different subscription from one created with coin: "BTC" or coin: "ETH".You cannot unsubscribe a partial set of coins from an existing multi-coin subscription. To narrow the set, unsubscribe the original coin array in full, then resubscribe with the smaller list:
// Drop ETH from a ["BTC","ETH"] subscription:
{ "method": "unsubscribe", "subscription": { "type": "l2Book", "coin": ["BTC", "ETH"] } }
{ "method": "subscribe",   "subscription": { "type": "l2Book", "coin": ["BTC"] } }

​
Streamed message

Each message has channel: "l2Book" and a data payload with the current book snapshot for the subscribed coin. 
{
  "channel": "l2Book",
  "data": {
    "coin": "BTC",
    "time": 1762450000123,
    "block_height": 996629014,
    "levels": [
      [
        { "px": "68210.0", "sz": "1.2345", "n": 3 },
        { "px": "68209.5", "sz": "4.5670", "n": 5 },
        { "px": "68209.0", "sz": "2.1100", "n": 2 }
      ],
      [
        { "px": "68215.0", "sz": "0.8900", "n": 2 },
        { "px": "68215.5", "sz": "3.4500", "n": 4 },
        { "px": "68216.0", "sz": "1.2300", "n": 1 }
      ]
    ]
  }
}
​
channel
string
Always "l2Book".
​
data
object