# GoldRush API Documentation - LLM Index ## Purpose This file provides a quick index of all available API endpoints and chain documentation for LLM consumption. ## Base URL https://goldrush.dev/docs/ ## API Selection Guide Choose the right API for your use case: ### Foundational API (Historical & Near Real-Time) API Type: REST Best for: Wallets, Portfolio Trackers, Tax Tools, Accounting, Compliance, RWA Registries, Block Explorers ### x402 API (Pay-Per-Request for AI Agents) API Type: REST (via x402 payment-gated proxy) Base URL: https://x402.goldrush.dev/v1 Best for: AI Agents, Autonomous Systems, Serverless/No-Account Access No API key required -pay per request with stablecoins on Base via the x402 protocol (HTTP 402). Provides access to 60+ Foundational API endpoints through a transparent reverse proxy. ## Endpoint Roles Determines how prominently LLMs should recommend each endpoint: - **primary** - Essential endpoints for common applications (wallets, portfolios, basic queries). Use these as the default recommendation. - **specialized** - Advanced endpoints for specific use cases (analytics, block explorers, historical snapshots). Only recommend when the user explicitly needs advanced functionality. - **legacy** - Kept for backwards compatibility but outdated or replaced by better alternatives. Avoid recommending unless specifically requested. ## Credit Cost Model API credits are charged based on the endpoint type: - **per call** - One credit charged per successful HTTP request (200 response) - **per item** - One credit charged per returned record (default max: 100 items per page) ## Critical Rules - Chain names are **case-sensitive** and must match the supported chain list (e.g. `eth-mainnet`, not "ethereum"). - Always send `Authorization: Bearer ` (no HTTP). - Pagination is 0-indexed and returns up to 100 items per page. - Always check `resp.error` before accessing `resp.data`. - Token balances are large strings; convert using `balance / 10^contract_decimals`. ## Rate Limits - Free 14 day trial: 25,000 API credits/month, 4 requests/second, no overages - Vibe Coding tier: $10/month for 10,000 included API credits, 4 requests/second, overages at $0.001/credit - Professional: $250/month for 300,000 included API credits, 50 requests/second, overages at $0.00077/credit - x402 (Pay-Per-Request): No subscription required, 100 requests/minute per wallet, pay with stablecoins on Base ## Foundational API - [Get Bitcoin balance for non-HD address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-bitcoin-balance-for-address): GET /v1/btc-mainnet/address/{walletAddress}/balances_v2/ · role: specialized · category: balances · credit: 1 per call · SDK: BitcoinService.getBitcoinNonHdWalletBalances() · op: getBitcoinBalanceForWalletAddress - [Get Bitcoin balances for HD address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-bitcoin-balances-for-hd-address): GET /v1/btc-mainnet/address/{walletAddress}/hd_wallets/ · role: specialized · category: balances · credit: 0.1 per item · SDK: BitcoinService.getBitcoinHdWalletBalances() · op: getBitcoinHdWalletBalances · uses: wallets, accounting-tax-reporting, portfolio-tracking - [Get ERC20 token transfers for address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-erc20-token-transfers-for-address): GET /v1/{chainName}/address/{walletAddress}/transfers_v2/ · role: primary · category: balances · credit: 0.05 per item · SDK: BalanceService.getErc20TransfersForWalletAddress() · op: getErc20TransfersForWalletAddress - [Get historical Bitcoin balance for non-HD address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-historical-bitcoin-balance-for-address): GET /v1/btc-mainnet/address/{walletAddress}/historical_balances/ · role: specialized · category: balances · credit: 1 per call · SDK: BitcoinService.getBitcoinNonHdWalletBalances() · op: getHistoricalBitcoinBalanceForWalletAddress · uses: accounting-tax-reporting, audit-compliance-forensics, portfolio-tracking - [Get historical portfolio value over time](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-historical-portfolio-value-over-time): GET /v1/{chainName}/address/{walletAddress}/portfolio_v2/ · role: primary · category: balances · credit: 2 per 30 days · SDK: BalanceService.getHistoricalPortfolioForWalletAddress() · op: getHistoricalPortfolioForWalletAddress · uses: portfolio-tracking, accounting-tax-reporting - [Get historical token balances for address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-historical-token-balances-for-address): GET /v1/{chainName}/address/{walletAddress}/historical_balances/ · role: specialized · category: balances · credit: 1 per call · SDK: BalanceService.getHistoricalTokenBalancesForWalletAddress() · op: getHistoricalTokenBalancesForWalletAddress - [Get native token balance for address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-native-token-balance): GET /v1/{chainName}/address/{walletAddress}/balances_native/ · role: primary · category: balances · credit: 0.5 per call · SDK: BalanceService.getNativeTokenBalance() · op: getNativeTokenBalance · uses: wallets, accounting-tax-reporting, portfolio-tracking - [Get token balances for address](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-token-balances-for-address): GET /v1/{chainName}/address/{walletAddress}/balances_v2/ · role: primary · category: balances · credit: 1 per call · SDK: BalanceService.getTokenBalancesForWalletAddress() · op: getTokenBalancesForWalletAddress · uses: wallets, portfolio-tracking, accounting-tax-reporting - [Get token holders as of any block height (v2)](https://goldrush.dev/docs/api-reference/foundational-api/balances/get-token-holders-as-of-any-block-height-v2): GET /v1/{chainName}/tokens/{tokenAddress}/token_holders_v2/ · role: specialized · category: balances · credit: 0.02 per item · SDK: BalanceService.getTokenHoldersV2ForTokenAddress() · op: getTokenHoldersV2ForTokenAddress - [Get activity across all chains for address](https://goldrush.dev/docs/api-reference/foundational-api/cross-chain/get-address-activity): GET /v1/address/{walletAddress}/activity/ · role: primary · category: base · credit: 0.5 per call · SDK: AllChainsService.getAddressActivity() · op: getAddressActivity - [Get multichain balances](https://goldrush.dev/docs/api-reference/foundational-api/cross-chain/get-allchains-balances): GET /v1/allchains/address/{walletAddress}/balances/ · role: specialized · category: allchains · credit: 2.5 per call · SDK: AllChainsService.getMultiChainBalances() · op: getTokenBalances · uses: wallets, accounting-tax-reporting, portfolio-tracking - [Get multichain & multiaddress transactions](https://goldrush.dev/docs/api-reference/foundational-api/cross-chain/get-allchains-transactions): GET /v1/allchains/transactions/ · role: specialized · category: allchains · credit: 0.25 per item · SDK: AllChainsService.getMultiChainMultiAddressTransactions() · op: getTransactions · uses: wallets, portfolio-tracking, audit-compliance-forensics, accounting-tax-reporting - [Check ownership in NFT collection for specific token](https://goldrush.dev/docs/api-reference/foundational-api/nft/check-ownership-in-nft-collection-token): GET /v1/{chainName}/address/{walletAddress}/collection/{collectionContract}/token/{tokenId}/ · role: specialized · category: nft · credit: 1 per call · op: checkOwnershipInNftForSpecificTokenId - [Check ownership in NFT collection](https://goldrush.dev/docs/api-reference/foundational-api/nft/check-ownership-in-nft-collection): GET /v1/{chainName}/address/{walletAddress}/collection/{collectionContract}/ · role: specialized · category: nft · credit: 1 per call · op: checkOwnershipInNft - [Get NFTs for address](https://goldrush.dev/docs/api-reference/foundational-api/nft/get-nfts-for-address): GET /v1/{chainName}/address/{walletAddress}/balances_nft/ · role: primary · category: nft · credit: 1 per call · op: getNftsForAddress - [Get token approvals for address](https://goldrush.dev/docs/api-reference/foundational-api/security/get-token-approvals-for-address): GET /v1/{chainName}/approvals/{walletAddress}/ · role: primary · category: security · credit: 2 per call · SDK: SecurityService.getApprovals() · op: getApprovals - [Get a transaction](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-a-transaction): GET /v1/{chainName}/transaction_v2/{txHash}/ · role: primary · category: transactions · credit: 0.1 per call · SDK: TransactionService.getTransaction() · op: getTransaction - [Get all transactions in a block by page (v3) ](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-all-transactions-in-a-block-by-page): GET /v1/{chainName}/block/{blockHeight}/transactions_v3/page/{page}/ · role: specialized · category: transactions · credit: 0.1 per item · op: getTransactionsForBlockByPage - [Get all transactions in a block (v3)](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-all-transactions-in-a-block): GET /v1/{chainName}/block_hash/{blockHash}/transactions_v3/ · role: specialized · category: transactions · credit: 0.1 per item · op: getTransactionsForBlockHash - [Get earliest transactions for address (v3) ](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-earliest-transactions-for-address-v3): GET /v1/{chainName}/bulk/transactions/{walletAddress}/ · role: specialized · category: transactions · credit: 0.1 per item · op: getEarliestTimeBucketTransactionsForAddress - [Get paginated transactions for address (v3)](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-paginated-transactions-for-address-v3): GET /v1/{chainName}/address/{walletAddress}/transactions_v3/page/{page}/ · role: primary · category: transactions · credit: 0.1 per item · op: getTransactionsForAddressV3 - [Get recent transactions for address (v3)](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-recent-transactions-for-address-v3): GET /v1/{chainName}/address/{walletAddress}/transactions_v3/ · role: primary · category: transactions · credit: 0.1 per item · op: getRecentTransactionsForAddress - [Get bulk time bucket transactions for address (v3)](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-time-bucket-transactions-for-address-v3): GET /v1/{chainName}/bulk/transactions/{walletAddress}/{timeBucket}/ · role: specialized · category: transactions · credit: 0.1 per item · SDK: TransactionService.getTimeBucketTransactionsForAddress() · op: getTimeBucketTransactionsForAddress - [Get transaction summary for address](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-transaction-summary-for-address): GET /v1/{chainName}/address/{walletAddress}/transactions_summary/ · role: primary · category: transactions · credit: 1 per call · SDK: TransactionService.getTransactionSummary() · op: getTransactionSummary - [Get Bitcoin transactions for non-HD address](https://goldrush.dev/docs/api-reference/foundational-api/transactions/get-transactions-for-bitcoin-address): GET /v1/cq/covalent/app/bitcoin/transactions/ · role: primary · category: transactions · credit: 0.1 per item · SDK: BitcoinService.getTransactionsForBtcAddress() · op: getTransactionsForBtcAddress - [Get a block](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-a-block): GET /v1/{chainName}/block_v2/{blockHeight}/ · role: specialized · category: base · credit: 1 per call · SDK: BaseService.getBlock() · op: getBlock - [Get all chain statuses](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-all-chain-statuses): GET /v1/chains/status/ · role: specialized · category: base · credit: 1 per call · SDK: BaseService.getAllChainStatus() · op: getAllChainStatus - [Get all chains](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-all-chains): GET /v1/chains/ · role: specialized · category: base · credit: 0.01 per call · SDK: BaseService.getAllChains() · op: getAllChains - [Get block heights](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-block-heights): GET /v1/{chainName}/block_v2/{startDate}/{endDate}/ · role: specialized · category: base · credit: 1 per call · SDK: BaseService.getBlockHeights() · op: getBlockHeights - [Get gas prices](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-gas-prices): GET /v1/{chainName}/event/{eventType}/gas_prices/ · role: primary · category: base · credit: 1 per call · SDK: BaseService.getGasPrices() · op: getGasPrices - [Get historical token prices](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-historical-token-prices): GET /v1/pricing/historical_by_addresses_v2/{chainName}/{quoteCurrency}/{contractAddress}/ · role: primary · category: pricing · credit: 1 per call · SDK: PricingService.getTokenPrices() · op: getTokenPrices - [Get log events by contract address](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-log-events-by-contract-address): GET /v1/{chainName}/events/address/{contractAddress}/ · role: specialized · category: base · credit: 0.01 per item · SDK: BaseService.getLogEventsByAddress() · op: getLogEventsByAddress - [Get log events by topic hash(es)](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-log-events-by-topic-hash): GET /v1/{chainName}/events/topics/{topicHash}/ · role: specialized · category: base · credit: 0.01 per item · SDK: BaseService.getLogEventsByTopicHash() · op: getLogEventsByTopicHash - [Get logs](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-logs): GET /v1/{chainName}/events/ · role: primary · category: base · credit: 0.01 per item · SDK: BaseService.getLogs() · op: getLogs - [Get pool spot prices](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-pool-spot-prices): GET /v1/pricing/spot_prices/{chainName}/pools/{contractAddress}/ · role: specialized · category: pricing · credit: 1 per call · SDK: PricingService.getPoolSpotPrices() · op: getPoolSpotPrices - [Get resolved address for registered address](https://goldrush.dev/docs/api-reference/foundational-api/utility/get-resolved-address-for-registered-address): GET /v1/{chainName}/address/{walletAddress}/resolve_address/ · role: primary · category: base · credit: 1 per call · SDK: BaseService.getResolvedAddress() · op: getResolvedAddress ## x402 API (Pay-Per-Request) The x402 API is a payment-gated proxy in front of the GoldRush Foundational API. AI agents pay per request using the x402 protocol (HTTP 402) with stablecoins on Base — no API keys, accounts, or subscriptions needed. Base URL: https://x402.goldrush.dev/v1 Protocol: x402 (HTTP 402 Payment Required) Network: Base Sepolia testnet (Base mainnet coming soon) Rate Limit: 100 requests/minute per wallet Client Libraries: @x402/core, @x402/evm ### How It Works 1. Agent calls an endpoint without payment 2. Server responds with HTTP 402 and payment instructions 3. Agent pays with stablecoins on Base and retries with proof of payment 4. Server validates the request before charging, then returns data ### Pricing Model - Fixed-Price Endpoints: One price per call (e.g., token balances, NFT holdings) - Tiered Pricing: For variable-length data - Small (1-50 items), Medium (51-200), Large (201-500), XL (501+) - Response Caching: Cached responses cost less (TTLs: 30s for balances, 5m for pricing data) ### Discovery Endpoints (Free) - [List all available x402 endpoints](https://goldrush.dev/docs/goldrush-x402/overview): GET /v1/x402/endpoints · Free · role: primary - [Search x402 endpoints](https://goldrush.dev/docs/goldrush-x402/overview): GET /v1/x402/search?q={query} · Free · role: primary - [Get details for a specific x402 endpoint](https://goldrush.dev/docs/goldrush-x402/overview): GET /v1/x402/endpoints/{endpoint-name} · Free · role: primary ### Data Endpoints (Paid via x402) All 60+ Foundational API endpoints are available through the x402 proxy. Key examples: - [Get token balances for address (x402)](https://goldrush.dev/docs/goldrush-x402/overview): GET /v1/{chainName}/address/{walletAddress}/balances_v2/ · pricing: fixed per call - [Get recent transactions for address (x402)](https://goldrush.dev/docs/goldrush-x402/overview): GET /v1/{chainName}/address/{walletAddress}/transactions_v3/ · pricing: tiered (?tier=small|medium|large|xl) ## Hyperliquid API Complete data layer for Hyperliquid: a no-rate-limit drop-in `/info` API at `https://hypercore.goldrushdata.com/info`, real-time HyperCore wallet and OHLCV streams, HIP-3 and HIP-4 market coverage, HyperCore warehouse delivery, and HyperEVM Foundational API support. - [Live Analytics App](https://goldrush.dev/docs/goldrush-hyperliquid/analytics-app): hyperliquid.goldrush.dev - a live Hyperliquid analytics app built on the GoldRush API. HIP-3 Market Screener, Liquidation Cascade Map, Market Health Score, and macro feeds. - [Early Builders Program](https://goldrush.dev/docs/goldrush-hyperliquid/early-builders-program): Free Hyperliquid API access for pre-revenue teams. Up to 1 million GoldRush credits over 12 months, monthly cohorts, REST and WebSocket from day one. - [Hyperliquid API Rate Limits, Caching & Polling](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/limits): The public Hyperliquid /info API is capped at 1200 request weight per minute per IP. The GoldRush Hyperliquid Info API removes that rate limit entirely - poll any endpoint as fast as you need. - [Info API Migration Guide](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/migration): Move from the public Hyperliquid /info API to GoldRush by changing one URL and one header. Step-by-step examples in cURL, JavaScript, and Python. - [Info API Overview](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/overview): A drop-in replacement for the public Hyperliquid `/info` REST API - fetch user trades (`userFills`), perp and spot account state (`clearinghouseState`), market metadata, and more with no rate limits and faster reads. - [SDK Compatibility](https://goldrush.dev/docs/goldrush-hyperliquid/info-api/sdk-compatibility): Use existing Hyperliquid SDKs (nomeida/hyperliquid for JS, hyperliquid-python-sdk for Python) against GoldRush by overriding the base URL and injecting an Authorization header. - [Hyperliquid API Overview](https://goldrush.dev/docs/goldrush-hyperliquid/overview): GoldRush is the complete, low-latency data infrastructure for Hyperliquid - the indexer and API provider behind a drop-in `/info` API replacement with no rate limits, real-time order book and wallet streams for HIP-3 and HIP-4 markets, and full HyperEVM coverage. - [Hyperliquid API Quickstart](https://goldrush.dev/docs/goldrush-hyperliquid/quickstart): Four 5-minute paths to get Hyperliquid data with GoldRush - drop-in Info API, real-time wallet streams, warehouse delivery, and batched account state. - [HIP-3 Markets](https://goldrush.dev/docs/goldrush-hyperliquid/streaming/hip3-markets): Discover and stream OHLCV for every HIP-3 builder-deployed perp market on Hyperliquid - equities, commodities, niche assets - using GoldRush's deployer-prefix syntax. - [HIP-4 Outcome Markets](https://goldrush.dev/docs/goldrush-hyperliquid/streaming/hip4-markets): Stream prediction-market outcomes on Hyperliquid - implied-probability charts, fills, and settlement detection for HIP-4 outcome contracts using the same GoldRush WebSocket primitives that power perps and spot. - [Liquidations and Vault Events](https://goldrush.dev/docs/goldrush-hyperliquid/streaming/liquidations-vaults): Pre-decoded liquidation, vault, staking, delegation, and borrow/lend events from HyperCore - typed and ready to consume, with no parsing required. - [Track Every Hyperliquid Wallet: the Wallet Firehose](https://goldrush.dev/docs/goldrush-hyperliquid/streaming/wallet-firehose): Hyperliquid has no public leaderboard or all-users API. GoldRush surfaces every active trader instead - stream fills from every wallet on HyperCore, then follow any set of addresses in one connection with zero rate limits. Powers copy-trade, whale alerts, and live trader dashboards. - [Build with the L2 Order Book Diff](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/l2-book-diff): Build cross-asset depth dashboards, market scanners, and arbitrage engines that track live aggregated book state across one coin, a fixed list, or every Hyperliquid asset on a single subscription - with bandwidth proportional to what changed each block, not the size of the book. - [Build with the L2 Order Book](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/l2-book): The Hyperliquid L2 order book over WebSocket - build top-of-book quote feeds, depth-weighted mid prices, slippage and market-impact estimators, and liquidity heatmaps from self-contained L2 snapshots, no diff replay or snapshot bootstrap required. - [Build with the L4 Order Book](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/l4-book): Build per-trader flow attribution, queue-position estimators, smart-money trackers, and microstructure analytics from individual Hyperliquid orders - with `user`, `oid`, `cloid`, `tif`, and trigger metadata exposed on every resting order. - [Hyperliquid WebSocket Rate Limits & Connection Limits](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/limits): The public Hyperliquid WebSocket caps subscriptions at 1000 per IP. The GoldRush Hyperliquid WebSocket API removes that limit and adds wildcard subscriptions - stream every asset on one connection. - [WebSocket API Migration Guide](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/migration): Move from the public Hyperliquid WebSocket to GoldRush by changing one URL. Step-by-step examples in wscat, JavaScript, and Python. - [WebSocket API Overview](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/overview): The Hyperliquid order book API over WebSocket - stream real-time L2 and L4 order book data for every asset on one connection, plus live wallet fills, with no per-IP subscription cap. A drop-in replacement for the public Hyperliquid WebSocket on `hypercore.goldrushdata.com`. - [SDK Compatibility](https://goldrush.dev/docs/goldrush-hyperliquid/websocket-api/sdk-compatibility): Use existing Hyperliquid SDKs (nomeida/hyperliquid for JS, hyperliquid-python-sdk for Python) against the GoldRush WebSocket API by overriding the WebSocket URL. - [activeAssetData | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/active-asset-data): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid activeAssetData: fetch a user's active trading limits, leverage setting, available size, and mark price for a single Hyperliquid perpetual asset. - [allMids | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/all-mids): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid allMids: fetch the current mid price for every actively traded asset in a single call. - [allPerpMetas | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/all-perp-metas): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid allPerpMetas: perpetuals universe and margin tables for every perp DEX in one request. - [batchClearinghouseState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/batch-clearinghouse-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid batchClearinghouseState: fetch perpetuals account state for up to 50 wallets in a single request. - [batchSpotClearinghouseState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/batch-spot-clearinghouse-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid batchSpotClearinghouseState: fetch spot account balances for up to 50 wallets in a single request. - [builderFillsByTime | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/builder-fills-by-time): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid builderFillsByTime: fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting. - [builderFills | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/builder-fills): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid builderFills: fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics. - [candleSnapshot | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/candle-snapshot): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid candleSnapshot: fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting. - [clearinghouseState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/clearinghouse-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid clearinghouseState: fetch a single user's perpetuals account state by wallet address. - [delegations | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegations): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid delegations: list a user's active HYPE staking delegations. - [delegatorHistory | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-history): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid delegatorHistory: reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary. - [delegatorRewards | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-rewards): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid delegatorRewards: fetch a user’s current HYPE staking position. - [delegatorSummary | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/delegator-summary): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid delegatorSummary: get a one-shot snapshot of a user's HYPE staking position for dashboards and portfolio overviews. - [exchangeStatus | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/exchange-status): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid exchangeStatus: fetch the current exchange operational status. - [extraAgents | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/extra-agents): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid extraAgents: list a user's approved API-agent wallets. - [frontendOpenOrders | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/frontend-open-orders): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid frontendOpenOrders: fetch a user's currently open orders enriched with frontend metadata. - [fundingHistory | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/funding-history): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid fundingHistory: fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies. - [l2Book | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/l2-book): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid l2Book: fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels. - [leadingVaults | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/leading-vaults): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid leadingVaults: list the vaults a user leads. - [liquidatable | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/liquidatable): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid liquidatable: list accounts currently eligible for liquidation. - [marginTable | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/margin-table): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid marginTable: fetch the margin-tier (leverage-bracket) table for a given margin table id. - [maxBuilderFee | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/max-builder-fee): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid maxBuilderFee: fetch the maximum builder fee a user has approved for a given builder. - [maxMarketOrderNtls | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/max-market-order-ntls): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid maxMarketOrderNtls: fetch the maximum market-order notional for each leverage bucket. - [metaAndAssetCtxs | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/meta-and-asset-ctxs): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid metaAndAssetCtxs: fetch the full Hyperliquid perpetuals market universe with live per-asset trading context. - [meta | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/meta): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid meta: fetch the perpetuals universe metadata without live market context. - [openOrders | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/open-orders): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid openOrders: list a user's resting open orders by wallet address. - [outcomeMeta | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/outcome-meta): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid outcomeMeta: enumerate all active HIP-4 binary outcome markets on HyperCore. - [perpDeployAuctionStatus | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-deploy-auction-status): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid perpDeployAuctionStatus: fetch the current perp-deploy Dutch-auction status. - [perpDexLimits | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-dex-limits): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid perpDexLimits: fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX. - [perpDexs | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/perp-dexs): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid perpDexs: enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore. - [perpsAtOpenInterestCap | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/perps-at-open-interest-cap): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid perpsAtOpenInterestCap: list the perp assets currently at their open-interest cap. - [portfolioState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/portfolio-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid portfolioState: fetch a wallet's perp state, spot balances, and account-abstraction mode in one request. - [settledOutcome | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/settled-outcome): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid settledOutcome: retrieve resolution details for a settled HIP-4 binary outcome market on HyperCore. - [spotClearinghouseState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-clearinghouse-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid spotClearinghouseState: fetch a single user's spot account balances by wallet address. - [spotDeployState | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-deploy-state): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid spotDeployState: fetch the spot-token deployment state and gas auction for a deployer. - [spotMetaAndAssetCtxs | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-meta-and-asset-ctxs): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid spotMetaAndAssetCtxs: fetch the spot universe metadata, token configuration, and live market data in a single call. - [spotMeta | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/spot-meta): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid spotMeta: fetch the spot universe metadata and full token configuration without live market context. - [subAccounts | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/sub-accounts): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid subAccounts: fetch a master wallet's sub-accounts along with their full perp and spot state in a single call. - [userAbstraction | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-abstraction): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userAbstraction: fetch a user's account-abstraction mode. - [userBorrowLendInterest | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-borrow-lend-interest): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userBorrowLendInterest: fetch a user's borrow/lend interest accrual history. - [userFees | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fees): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userFees: fetch a user's fee schedule and recent daily trading volume. - [userFillsByTime | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fills-by-time): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userFillsByTime: fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction. - [userFills | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-fills): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userFills: fetch a user's most recent trade fills without specifying a time window. - [userFunding | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-funding): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userFunding: fetch a user's per-coin funding payment history within a time window for funding-only P&L attribution. - [userNonFundingLedgerUpdates | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-non-funding-ledger-updates): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userNonFundingLedgerUpdates: fetch a user's non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time window. - [userRateLimit | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-rate-limit): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userRateLimit: fetch a user's API rate-limit usage and cap. - [userRole | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-role): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userRole: fetch a user's account role. - [userToMultiSigSigners | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-to-multi-sig-signers): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userToMultiSigSigners: fetch the authorized signers for a multi-sig user. - [userTwapSliceFillsByTime | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-twap-slice-fills-by-time): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userTwapSliceFillsByTime: fetch a user's TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders. - [userTwapSliceFills | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-twap-slice-fills): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userTwapSliceFills: fetch a user's most recent TWAP slice fills for execution-quality analytics on algorithmic orders. - [userVaultEquities | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/user-vault-equities): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid userVaultEquities: fetch a user's locked vault equity positions across all vaults they have deposited into. - [validatorL1Votes | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/validator-l1-votes): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid validatorL1Votes: fetch the pending validator L1 governance votes/actions. - [vaultDetails | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-details): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid vaultDetails: fetch detailed information for a specific vault. - [vaultSummaries | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/vault-summaries): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid vaultSummaries: list summary information for every vault on the platform. - [webData2 | Hyperliquid Info API](https://goldrush.dev/docs/api-reference/hyperliquid-info/web-data2): API: POST https://hypercore.goldrushdata.com/info · Hyperliquid webData2: fetch the composite snapshot the Hyperliquid web app uses for a wallet in a single call. - [allFills | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/all-fills): Hyperliquid allFills: stream every fill on HyperCore in real time for global market analytics and cross-wallet order-flow monitoring. - [builderFills | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/builder-fills): Hyperliquid builderFills: stream live attributed fills for one or more builder addresses in real time. - [builderLiquidations | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/builder-liquidations): Hyperliquid builderLiquidations: stream liquidation fills attributed to your builder code in real time. - [l2BookDiff | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l2-book-diff): Hyperliquid l2BookDiff: subscribe to real-time L2 order book (initial snapshot + diffs) for all Hyperliquid assets over WebSocket. - [l2Book | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l2-book): Hyperliquid l2Book: subscribe to real-time L2 order book snapshots for all Hyperliquid assets over WebSocket. - [l4Book | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/l4-book): Hyperliquid l4Book: subscribe to GoldRush's order-level Hyperliquid book - initial snapshot of every resting order plus per-block diffs with full metadata. - [liquidationFills | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/liquidation-fills): Hyperliquid liquidationFills: stream a global, market-wide feed of every liquidation fill on HyperCore. - [orderUpdates | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/order-updates): Hyperliquid orderUpdates: stream real-time order lifecycle events (placements, fills, cancels, and rejections) for one or more wallets on HyperCore. - [userFills | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/user-fills): Hyperliquid userFills: stream real-time trade fills for one or more wallets as they execute on HyperCore. - [userNonFundingLedgerUpdates | Hyperliquid WebSocket API](https://goldrush.dev/docs/api-reference/hyperliquid-websocket/user-non-funding-ledger-updates): Hyperliquid userNonFundingLedgerUpdates: stream real-time non-funding ledger events (deposits, withdrawals, vault and staking activity) for one or more wallets. ## Solana API Complete data layer for Solana: REST endpoints for SPL token balances (Token + Token-2022), historical balances by slot, SPL transfers, transactions by base58 signature, NFTs (Metaplex + Bubblegum cNFTs), historical and spot prices, and Solana-native primitives. Warehouse delivery for decoded swaps and SPL transfers. - Foundational API on Solana Path: goldrush-solana/foundational/overview Description: REST endpoint on Solana for SPL token balances. - Wallet endpoints on Solana Path: goldrush-solana/foundational/wallet Description: REST endpoint on Solana for SPL token balances. - Solana API Overview Path: goldrush-solana/overview Description: GoldRush on Solana: SPL token balances (REST); decoded DEX swaps and SPL transfers (warehouse). - Solana API Quickstart Path: goldrush-solana/quickstart Description: Two quickstarts for Solana on GoldRush: SPL token balances (REST) and DEX swaps to a warehouse. - Solana DEX Swaps to your warehouse Path: goldrush-solana/warehouse/dex-swaps Description: Land decoded Solana DEX trades into ClickHouse, BigQuery, Postgres, Kafka, or S3 via the `swaps` normalizer. - Solana SPL Transfers to your warehouse Path: goldrush-solana/warehouse/spl-transfers Description: Land decoded SPL token transfers on Solana into ClickHouse, BigQuery, Postgres, Kafka, or S3 via the `transfers` normalizer. ## Chain Documentation ### Support Levels **Foundational:** These are the top EVM-compatible chains with guaranteed product parity across the entire GoldRush feature suite, including tracing enhancements. Key features that are only supported for these chains include: - **Historical token balances** - **Token holders list for any block height** - **DEX spot prices** **Frontier:** Cutting-edge blockchain networks where GoldRush continues to expand feature coverage as the ecosystem evolves. This category includes all non-EVM chains and may include special APIs (e.g. Bitcoin). **Community:** Community-driven blockchain networks with growing GoldRush integration and feature support. All core onchain data such as spot balances, transaction histories for addresses and decoded event logs are provided. **Archived:** Previously supported blockchain networks that are now in archived status with limited data availability. No live data is available for these chains. - [ADI Chain](https://goldrush.dev/docs/chains/adi-chain): chain: adi-mainnet · chain id: 36900 · support: frontier - [ApeChain](https://goldrush.dev/docs/chains/apechain): chain: apechain-mainnet · chain id: 33139 · support: frontier - [Arbitrum Nova](https://goldrush.dev/docs/chains/arbitrum-nova): chain: arbitrum-nova-mainnet · chain id: 42170 · support: frontier - [Arbitrum](https://goldrush.dev/docs/chains/arbitrum): chain: arbitrum-mainnet · chain id: 42161 · support: frontier - [Arc Testnet](https://goldrush.dev/docs/chains/arc): chain: arc-testnet · chain id: 5042002 · support: frontier - [Avalanche C-Chain](https://goldrush.dev/docs/chains/avalanche-c-chain): chain: avalanche-mainnet · chain id: 43114 · support: frontier - [Axie/Ronin](https://goldrush.dev/docs/chains/axie-ronin): chain: axie-mainnet · chain id: 2020 · support: frontier - [Base](https://goldrush.dev/docs/chains/base): chain: base-mainnet · chain id: 8453 · support: foundational - [Berachain](https://goldrush.dev/docs/chains/berachain): chain: berachain-mainnet · chain id: 80094 · support: frontier - [Bitcoin](https://goldrush.dev/docs/chains/bitcoin): chain: btc-mainnet · chain id: 20090103 · support: frontier - [Blast](https://goldrush.dev/docs/chains/blast): chain: blast-mainnet · chain id: 81457 · support: community - [BNB Smart Chain (BSC)](https://goldrush.dev/docs/chains/bnb-smart-chain-bsc): chain: bsc-mainnet · chain id: 56 · support: foundational - [Canto](https://goldrush.dev/docs/chains/canto): chain: canto-mainnet · chain id: 7700 · support: community - [Celo](https://goldrush.dev/docs/chains/celo): chain: celo-mainnet · chain id: 42220 · support: community - [Cronos zkEVM](https://goldrush.dev/docs/chains/cronos-zkevm): chain: cronos-zkevm-mainnet · chain id: 388 · support: community - [Cronos](https://goldrush.dev/docs/chains/cronos): chain: cronos-mainnet · chain id: 25 · support: archived - [Ethereum](https://goldrush.dev/docs/chains/ethereum): chain: eth-mainnet · chain id: 1 · support: foundational - [Fantom](https://goldrush.dev/docs/chains/fantom): chain: fantom-mainnet · chain id: 250 · support: community - [Gnosis](https://goldrush.dev/docs/chains/gnosis): chain: gnosis-mainnet · chain id: 100 · support: foundational - [Harmony](https://goldrush.dev/docs/chains/harmony): chain: harmony-mainnet · chain id: 1666600000 · support: archived - [HyperCore](https://goldrush.dev/docs/chains/hypercore): chain: hypercore-mainnet · chain id: na · support: frontier - [HyperEVM](https://goldrush.dev/docs/chains/hyperevm): chain: hyperevm-mainnet · chain id: 999 · support: frontier - [Ink](https://goldrush.dev/docs/chains/ink): chain: ink-mainnet · chain id: 57073 · support: frontier - [Linea](https://goldrush.dev/docs/chains/linea): chain: linea-mainnet · chain id: 59144 · support: frontier - [Lisk Onchain Data API](https://goldrush.dev/docs/chains/lisk) - [Manta Pacific Testnet](https://goldrush.dev/docs/chains/manta-pacific): chain: manta-sepolia-testnet · chain id: 3441006 · support: community - [Mantle](https://goldrush.dev/docs/chains/mantle): chain: mantle-mainnet · chain id: 5000 · support: frontier - [MegaETH](https://goldrush.dev/docs/chains/megaeth): chain: megaeth-mainnet · chain id: 4326 · support: frontier - [Monad](https://goldrush.dev/docs/chains/monad): chain: monad-mainnet · chain id: 143 · support: frontier - [Moonbeam](https://goldrush.dev/docs/chains/moonbeam): chain: moonbeam-mainnet · chain id: 1284 · support: community - [Moonriver](https://goldrush.dev/docs/chains/moonriver): chain: moonbeam-moonriver · chain id: 1285 · support: community - [Oasis Sapphire](https://goldrush.dev/docs/chains/oasis-sapphire): chain: oasis-sapphire-mainnet · chain id: 23294 · support: frontier - [Oasis](https://goldrush.dev/docs/chains/oasis): chain: emerald-paratime-mainnet · chain id: 42262 · support: community - [opBNB](https://goldrush.dev/docs/chains/opbnb): chain: bnb-opbnb-mainnet · chain id: 204 · support: community - [Optimism](https://goldrush.dev/docs/chains/optimism): chain: optimism-mainnet · chain id: 10 · support: foundational - [Plasma](https://goldrush.dev/docs/chains/plasma): chain: plasma-mainnet · chain id: 9745 · support: frontier - [Polygon](https://goldrush.dev/docs/chains/polygon): chain: matic-mainnet · chain id: 137 · support: foundational - [Redstone](https://goldrush.dev/docs/chains/redstone): chain: redstone-mainnet · chain id: 690 · support: community - [Robinhood Chain Onchain Data API](https://goldrush.dev/docs/chains/robinhood-chain) - [Scroll](https://goldrush.dev/docs/chains/scroll): chain: scroll-mainnet · chain id: 534352 · support: frontier - [Sei](https://goldrush.dev/docs/chains/sei): chain: sei-mainnet · chain id: 1329 · support: frontier - [Solana](https://goldrush.dev/docs/chains/solana): chain: solana-mainnet · chain id: 1399811149 · support: frontier - [Sonic](https://goldrush.dev/docs/chains/sonic): chain: sonic-mainnet · chain id: 146 · support: frontier - [Taiko](https://goldrush.dev/docs/chains/taiko): chain: taiko-mainnet · chain id: 167000 · support: frontier - [Tempo Onchain Data API](https://goldrush.dev/docs/chains/tempo) - [Unichain](https://goldrush.dev/docs/chains/unichain): chain: unichain-mainnet · chain id: 130 · support: frontier - [Viction](https://goldrush.dev/docs/chains/viction): chain: viction-mainnet · chain id: 88 · support: frontier - [World Chain](https://goldrush.dev/docs/chains/world-chain): chain: world-mainnet · chain id: 480 · support: frontier - [ZetaChain](https://goldrush.dev/docs/chains/zetachain): chain: zetachain-mainnet · chain id: 7000 · support: community - [zkSync Era](https://goldrush.dev/docs/chains/zksync-era): chain: zksync-mainnet · chain id: 324 · support: frontier