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.

The GoldRush Hyperliquid Info API is a drop-in replacement for POST https://api.hyperliquid.xyz/info. The request body, the response shape, and the JSON keys are byte-for-byte identical to the public Hyperliquid API. The only differences are the URL and the authentication header. Sixteen type values are supported today across market metadata, user state, user history, vaults, and staking - plus two GoldRush-native batch endpoints with no upstream equivalent.

Endpoint

POST https://hypercore.goldrushdata.com/info
Authorization: Bearer <GOLDRUSH_API_KEY>
Content-Type: application/json

Comparison with the public Hyperliquid API

Public APIGoldRush
URLhttps://api.hyperliquid.xyz/infohttps://hypercore.goldrushdata.com/info
AuthNoneAuthorization: Bearer <key>
Rate limit1200 weight/min/IPNone
Orderbook latency targetp50: ~280 msp50: <150 ms
Wire compatibilityn/a (it’s the source)Byte-for-byte
Available typesSee Hyperliquid DocsSee Available types
Types not in public APIn/aBatched user state, builder fills, liquidation feed, composites - see Roadmap
Unsupported typesn/aReturn {"error":"unsupported_type","type":"<x>"} instead of being forwarded

Available types

The Info API supports the wire-compatible drop-in types below, organized by what they return. Two GoldRush-native batch endpoints (batchClearinghouseState, batchSpotClearinghouseState) have no upstream Hyperliquid equivalent.

Market metadata

TypeBodyReturns
metaAndAssetCtxs{"type": "metaAndAssetCtxs", "dex": ""}Tuple [meta, assetCtxs[]] - perp universe + per-asset live mark price, funding, OI, day volume.
spotMetaAndAssetCtxs{"type": "spotMetaAndAssetCtxs"}Tuple [spotMeta, assetCtxs[]] - spot universe + per-pair live mark price, mid, day volume.
outcomeMeta{"type": "outcomeMeta"}Active HIP-4 outcome universe - integer outcome IDs, names, structured descriptions, and sideSpecs (Yes / No).

User account state

TypeBodyReturns
clearinghouseState{"type": "clearinghouseState", "user": "0x…", "dex": ""}Perp account: positions, margin summary, account value, withdrawable.
spotClearinghouseState{"type": "spotClearinghouseState", "user": "0x…", "dex": ""}Spot balances per token, total USD value.
frontendOpenOrders{"type": "frontendOpenOrders", "user": "0x…", "dex": ""}Open orders + trigger metadata (TP/SL, isPositionTpsl, reduceOnly, orderType).
subAccounts{"type": "subAccounts", "user": "0x…"}List of sub-accounts owned by a master, each with its inlined perp and spot state.

User history

TypeBodyReturns
userFillsByTime{"type": "userFillsByTime", "user": "0x…", "startTime": …}Fills bounded by a time window.
userFunding{"type": "userFunding", "user": "0x…", "startTime": …}Funding payment history with rate, applied size, and USDC delta per event.
userNonFundingLedgerUpdates{"type": "userNonFundingLedgerUpdates", "user": "0x…", "startTime": …}Ledger events except funding - deposits, withdrawals, transfers, vault flows, liquidations.

Vaults & staking

TypeBodyReturns
userVaultEquities{"type": "userVaultEquities", "user": "0x…"}Per-vault locked equity with unlock timestamps.
delegatorSummary{"type": "delegatorSummary", "user": "0x…"}Current delegated, undelegated, and pending-withdrawal HYPE totals.
delegatorHistory{"type": "delegatorHistory", "user": "0x…"}Delegate, undelegate, deposit, and withdrawal staking events.
delegatorRewards{"type": "delegatorRewards", "user": "0x…"}Accrued staking rewards (delegation and validator commission).

GoldRush-native batch

TypeBodyReturns
batchClearinghouseState{"type": "batchClearinghouseState", "users": ["0x…", …], "dex": ""}Array of clearinghouseState slots. GoldRush-native, 1 to 50 wallets per call.
batchSpotClearinghouseState{"type": "batchSpotClearinghouseState", "users": ["0x…", …]}Array of spotClearinghouseState slots. GoldRush-native, 1 to 50 wallets per call.
If you send a type that isn’t in the table above, the response body is {"error":"unsupported_type","type":"<the type you sent>"}. Requests are not forwarded to upstream Hyperliquid. Type expansion is tracked on the Roadmap. See the Roadmap for what’s shipping next.

How clients see it

Existing Hyperliquid SDKs work unchanged after a baseUrl override. See SDK compatibility for nomeida/hyperliquid (JS) and hyperliquid-dex/hyperliquid-python-sdk setup snippets.

Errors

StatusBodyCause
400{"error":"invalid request"}Malformed body.
400{"error":"unsupported_type","type":"<type>"}The type field isn’t one of the natively-supported types.
401{"error":"unauthorized"}Missing or invalid Authorization header.
5xxServer errorInternal server error.

Networks

Mainnet only. Testnet support is deferred.

Next

Migration guide

Side-by-side examples - change one URL and one header.

SDK compatibility

Drop-in setup for nomeida/hyperliquid and hyperliquid-python-sdk.

Limits and caching

No rate limits - what to know about caching and recommended polling cadences.

API reference

Per-endpoint request and response schemas.