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.
The GoldRush Hyperliquid API ships in phases. Available endpoints are documented under Info API; this page covers what’s coming.
Available now
The Info API ships with six types: four wire-compatible drop-ins covering the core “show me the market and my account” UX, plus two GoldRush-native batch endpoints.
| Type | Description |
|---|
metaAndAssetCtxs | Perp universe + per-asset live mark price, funding, OI, and day volume. |
clearinghouseState | Perp account: positions, margin summary, account value, withdrawable. |
spotClearinghouseState | Spot balances per token, total USD value. |
frontendOpenOrders | Open orders + trigger metadata (TP/SL, reduceOnly, orderType). |
batchClearinghouseState | Perp account state for 1 to 50 wallets in one request. GoldRush-native, no upstream equivalent. |
batchSpotClearinghouseState | Spot balances for 1 to 50 wallets in one request. GoldRush-native, no upstream equivalent. |
Next: Top ~20 Info API types
We’re expanding the Info API to the most-used types on the public Hyperliquid /info surface. Backed by data we already ingest in real time.
| Category | Types | Notes |
|---|
| Meta | meta, spotMeta, spotMetaAndAssetCtxs | Perp and spot universe metadata. |
| Prices | allMids | All-asset mark prices. |
| Orderbook | l2Book | Sub-150 ms p50 target. |
| Trades | recentTrades, candleSnapshot | Backed by the same fills we already stream. |
| User orders & fills | openOrders, userFills, userFillsByTime, historicalOrders, orderStatus | No 10,000-row cap - full history. |
| User ledger | userFunding, userNonFundingLedgerUpdates, fundingHistory | Pre-decoded into typed events. |
| Misc | userFees, userRateLimit, referral, portfolio | Coming soon. |
{"error":"unsupported_type","type":"<the type you sent>"}. Email us at [email protected] to prioritize a specific type.
Then: Power-user endpoints
Capabilities that go beyond the public /info surface, addressable from the same POST /info body.
| Type | What it adds |
|---|
builderFills | Fills attributed to a specific builder code address. |
builderLiquidations | Liquidations attributed to a specific builder. |
liquidationFills | Market-wide liquidation feed, paged. |
webData2 (composite) | One call returns clearinghouseState + openOrders + meta + assetCtxs + recent fills. Saves 4–5 round trips for dashboards. |
perpDexs | List of all HIP-3 and HIP-4 builder-deployed perp DEXes. First-class HIP-3 and HIP-4 coverage across meta and metaAndAssetCtxs when dex is provided. |
Historical depth
- Extended retention on
hl_trades and hl_fills.
- Bulk archive export -
GET /archive/{type}.parquet?from=…&to=… returns a presigned URL for backfill into your warehouse.
Ergonomics
Accept-Encoding: zstd for smaller payloads.- Optional
?fields= parameter for response field projection.
Best-in-class differentiators
Capabilities no other Hyperliquid data provider offers today.
Time-travel info (asOfMs)
Every user-state and market type accepts an optional asOfMs parameter. Replay any wallet’s state at any past timestamp using the same /info request body.
Use cases: historical PnL audits, snapshot for tax reports, “what did this account look like before liquidation,” backtest harnesses.
Cross-venue unified perpetuals
New types unifiedMeta and unifiedClearinghouseState merge Hyperliquid + Drift + dYdX + Aevo positions for a wallet into one response.
Use cases: multi-venue portfolio dashboards, cross-margin monitoring, unified risk engines.
Streaming mirror via SSE and gRPC
Mirror every WebSocket subscription as:
- Server-Sent Events (
GET /info/stream?type=…) - works through corporate proxies and serverless edges where WS is blocked.
- gRPC with Protobuf - 3–5× lower bandwidth, hard typing for institutional clients.
Smart-money and ML-derived analytics
Types not derivable from raw Hyperliquid data:
| Type | Description |
|---|
whaleFlow | Net 1h/24h delta for top-N PnL wallets per coin. |
predictedFunding | Funding forecast extending Hyperliquid’s next-epoch-only horizon. |
liquidationHeatmap | Clustered liquidation prices by coin. |
walletScore | Risk, PnL, and Sharpe per wallet. |
Verifiable responses
Every response carries an X-Hl-Proof: <signature> header over {type, params_hash, body_hash, ingest_block_height}. Public key published. Lets institutional clients audit they got real on-chain-derived data, not stale or tampered output.
Have a request?
Need a type or capability that isn’t on this list? Email us - we prioritize against real customer use cases.
