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.

Returns a tuple [meta, assetCtxs[]] covering the entire Hyperliquid perpetuals universe - every coin’s metadata plus a live snapshot of mark price, funding rate, open interest, and 24-hour volume. This is a global, non-user-keyed type. A single cache entry is shared across all callers and is refreshed continuously from upstream Hyperliquid.

Endpoint

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

Request

type
string
required
Always "metaAndAssetCtxs".
dex
string
HIP-3 builder DEX identifier. Empty string (default) returns the canonical Hyperliquid perp universe. Pass a builder code (e.g. "xyz") to query a HIP-3 deployer’s universe.

Example

curl -X POST https://hypercore.goldrushdata.com/info \
  -H "Authorization: Bearer $GOLDRUSH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "metaAndAssetCtxs",
    "dex": ""
  }'

Response

A two-element JSON array. Element 0 is the universe metadata; element 1 is an array of per-asset contexts indexed identically to the universe array.
[
  {
    "universe": [
      { "name": "BTC", "szDecimals": 5, "maxLeverage": 50 },
      { "name": "ETH", "szDecimals": 4, "maxLeverage": 50 },
      { "name": "SOL", "szDecimals": 2, "maxLeverage": 20 }
    ]
  },
  [
    {
      "funding": "0.0000125",
      "openInterest": "12345.67",
      "prevDayPx": "67500.0",
      "dayNtlVlm": "894500000.0",
      "premium": "0.00001",
      "oraclePx": "68210.5",
      "markPx": "68215.0",
      "midPx": "68214.0",
      "impactPxs": ["68210.0", "68220.0"],
      "dayBaseVlm": "13130.45"
    },
    { "funding": "0.0000050", "openInterest": "9876.54", "...": "..." },
    { "funding": "0.0000200", "openInterest": "543210.98", "...": "..." }
  ]
]

Element 0: meta

universe
array<object>
Array of perp asset metadata, indexed identically to element 1’s assetCtxs.

Element 1: assetCtxs[]

Array of per-asset live context, indexed identically to universe.
funding
string
Current funding rate (decimal string).
openInterest
string
Open interest in base units.
prevDayPx
string
Mark price 24 hours ago.
dayNtlVlm
string
24-hour notional volume in USD.
premium
string
Mark vs oracle premium.
oraclePx
string
Current oracle price.
markPx
string
Current mark price.
midPx
string
Current orderbook mid price.
impactPxs
array<string>
Bid/ask impact prices [bidImpact, askImpact].
dayBaseVlm
string
24-hour volume in base units.

Notes

  • Wire-equal to POST api.hyperliquid.xyz/info with {"type": "metaAndAssetCtxs"}.
  • For real-time mark-price updates, use the Streaming API OHLCV streams instead of polling.