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.

Pick the path that matches what you’re building. All three use the same GoldRush API key.

​
Prerequisites

A GoldRush API key. Sign up at goldrush.dev/platform.

Vibe Coders

$10/mo - Built for solo builders and AI-native workflows.

Teams

$250/mo - Production-grade with priority support.

​
1. Drop-in Info API

If your code already calls POST https://api.hyperliquid.xyz/info, swap the URL to https://hypercore.goldrushdata.com/info and add an Authorization: Bearer header. The request body and response shape stay byte-for-byte identical. 
curl -X POST https://hypercore.goldrushdata.com/info \
  -H "Authorization: Bearer <GOLDRUSH_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"type": "metaAndAssetCtxs"}'
That’s it. No rate limits, faster reads, and the response is byte-equal to Hyperliquid (modulo live-value drift). See the full migration guide for SDK overrides and behavioral notes:

Info API Migration Guide

Side-by-side examples in JS, Python, and cURL - including how to point existing SDKs at GoldRush.

​
2. Stream wallet activity

Subscribe to one or many HyperCore wallets in real time over WebSocket. Pre-decoded events include fills with liquidation context, funding payments, vault actions, and 20+ ledger subtypes. 
import { GoldRushClient } from "@covalenthq/client-sdk";

const client = new GoldRushClient(process.env.GOLDRUSH_API_KEY);

const SUBSCRIPTION_QUERY = `
  subscription {
    walletTxs(
      wallet_addresses: ["0xecb63caa47c7c4e77f60f1ce858cf28dc2b82b00"]
      chain_name: HYPERCORE_MAINNET
    ) {
      tx_hash
      block_signed_at
      decoded_details {
        ... on HypercoreFillTransaction {
          coin
          side
          price
          size
          closed_pnl
          liquidation { method liquidated_user market_price }
        }
        ... on HypercoreFundingEvent { coin funding_rate funding_amount }
      }
    }
  }
`;

client.StreamingService.rawQuery(
  SUBSCRIPTION_QUERY,
  {},
  {
    next: (data) => console.log(JSON.stringify(data, null, 2)),
    error: (err) => console.error(err),
    complete: () => console.log("done"),
  }
);
The walletTxs subscription has zero rate limits and scales to thousands of concurrent wallet subscriptions per connection. See Wallet firehose for the full pattern.

​
3. Pipe fills to your warehouse

Stream HyperCore fills into ClickHouse, BigQuery, Postgres, Kafka, or S3 with one config - no ETL on your side.
1

Create a pipeline

In the GoldRush Platform, navigate to Manage Pipelines and click Create Pipeline.
2

Pick HyperCore + Fills

Choose Hyperliquid as the chain and Fills as the data type.
3

Choose your destination

Connect ClickHouse, BigQuery, Postgres, Kafka, S3/GCS/R2, SQS, or a Webhook.
4

Deploy

Fills begin flowing within seconds.
Full walkthrough with sample SQL: Stream Hyperliquid trades to ClickHouse.

​
4. Fan out across many wallets

Need account state for many wallets at once? batchClearinghouseState and batchSpotClearinghouseState accept 1 to 50 wallets per call and fan them out in parallel against our private node. There is no equivalent on the public Hyperliquid /info API. Each slot in the response is either the raw upstream object for that wallet (success) or a thin error envelope ({error, user, message}) when an individual wallet fails. The HTTP status stays 200 OK even on partial failure - always check for the error key on each slot. 
const response = await fetch("https://hypercore.goldrushdata.com/info", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.GOLDRUSH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "batchClearinghouseState",
    users: [
      "0xb0a55f13d22f66e6d495ac98113841b2326e9540",
      "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc",
      "0x31ca8395cf837de08b24da3f660e77761dfb974b",
    ],
  }),
});

const slots = await response.json();

for (const [i, slot] of slots.entries()) {
  if ("error" in slot) {
    console.warn(`wallet ${slot.user} failed: ${slot.message}`);
    continue;
  }
  console.log(`wallet ${i}: ${slot.withdrawable} USD withdrawable`);
}
Duplicates in users are removed (case-insensitive); input order is preserved for the survivors. For batches larger than 50, issue multiple calls. Use cases: portfolio dashboards, multi-wallet PnL aggregators, fleet-level liquidation risk monitoring, treasury balance reconciliation. Full reference: batchClearinghouseState, batchSpotClearinghouseState.

​
What’s next

HIP-3 markets

Real-time OHLCV for every builder-deployed perp market - equities, commodities, niche assets.

Liquidations & vault events

Pre-decoded LedgerLiquidation, LedgerVaultDeposit, LedgerVaultWithdraw, and 17 more subtypes.

Roadmap

Time-travel queries, cross-venue unification, signed responses - what’s shipping next.

Live analytics

HIP-3 Market Screener, Liquidation Cascade Map, Market Health Score.