The GoldRush Hyperliquid WebSocket API is a drop-in replacement forDocumentation Index
Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
wss://api.hyperliquid.xyz/ws. Subscription payloads, channel names, and message shapes are byte-for-byte identical to the public Hyperliquid feed. The only difference is the connection URL - authentication is a required key query parameter, so no header changes are needed in your client.
Endpoint
Your GoldRush API key. Passed as a query parameter at connection time.
Comparison with the public Hyperliquid WebSocket
| Public WebSocket | GoldRush | |
|---|---|---|
| URL | wss://api.hyperliquid.xyz/ws | wss://hypercore.goldrushdata.com/ws?key=<GOLDRUSH_API_KEY> |
| Auth | None | key query parameter (required) |
| Subscriptions per IP | 1000 | No cap |
| Wire compatibility | n/a (it’s the source) | Byte-for-byte |
| Available channels | See Hyperliquid Docs | See Available subscriptions |
Available subscriptions
| Channel | Subscription body | Returns |
|---|---|---|
l2Book | {"type": "l2Book", "coin": "BTC"} | Real-time L2 order book snapshots - bids and asks aggregated by significant figures. |
Limits
No 1000-subscription-per-IP cap and filter parameters are optional (omitcoin to stream the full L2 book across every asset on a single subscription). See Limits & connections for details.
For richer real-time analytics (pre-decoded HyperCore fills, liquidations, vault events, OHLCV across every HIP-3/HIP-4 market), pair the WebSocket with the GraphQL Streaming API.