The public HyperliquidDocumentation Index
Fetch the complete documentation index at: https://goldrush.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
/info API surfaces raw building blocks; you write the parser. Liquidations are buried inside fills as a thin stub, and vault, staking, and delegation activity arrives as untyped ledger updates you have to classify yourself.
GoldRush ships every one of these pre-decoded and typed.
What’s pre-decoded
Liquidations
Inline with the fill that triggered them, with full context:| Field | Description |
|---|---|
method | Market or Backstop. |
liquidated_user | The wallet whose position was liquidated. |
market_price | Mark price at the moment of liquidation. |
liquidated_positions[] | Every position closed by the liquidation (coin + size). |
account_value | Account value at the time of liquidation. |
leverage_type | Cross or isolated. |
20+ ledger event subtypes
| Subtype | Description |
|---|---|
LedgerLiquidation | Standalone liquidation ledger event with full position list. |
LedgerVaultDeposit | Deposit into a vault. |
LedgerVaultWithdraw | Withdrawal request from a vault, with commission and basis. |
LedgerVaultLeaderCommission | Commission earned by a vault leader. |
LedgerVaultDistribution | Distribution from a vault to depositors. |
LedgerVaultCreate | New vault creation event. |
LedgerCStakingTransfer | Hyperliquid staking deposit/withdrawal. |
LedgerBorrowLend | Borrow or lend operation. |
LedgerRewardsClaim | Validator or program reward claim. |
LedgerDeposit, LedgerWithdraw | Bridge in/out. |
LedgerInternalTransfer | Sub-account transfer. |
LedgerSpotTransfer | Spot token transfer with USDC value. |
LedgerSubAccountTransfer | Sub-account funds movement. |
LedgerSend | Cross-DEX send (with source_dex and destination_dex). |
LedgerAccountClassTransfer | Account-class movement (perp/spot). |
LedgerAccountActivationGas | Activation gas charged on first deposit. |
LedgerSpotGenesis | Spot token genesis allocation. |
LedgerDeployGasAuction | HIP-3 market deployment gas auction. |
LedgerPerpDexClassTransfer | Transfer between HIP-3 perp DEXes and core perp. |
HypercoreLedgerEvent for the full type with all fields.
Funding, deposits, withdrawals, delegations
Each gets its own typed event:HypercoreFundingEvent- funding rate payment with coin, rate, and amount.HypercoreDepositEvent- cross-chain deposit into HyperCore.HypercoreWithdrawalEvent- finalized cross-chain withdrawal.HypercoreDelegationEvent- staking delegation or undelegation with validator address.
Subscribe
Pull liquidations, fills, and ledger events for a wallet (or many) in one stream:Patterns
Live liquidation tape
Filter the stream onHypercoreFillTransaction where liquidation is non-null. Display each liquidation in a chronological feed with the user, mark price, method, and total position value.
”X just got liquidated for $Y” notifications
Push every non-nullliquidation to a notification channel. Use account_value to compute the dollar size and liquidated_positions[] to list the markets.
Position-risk warnings
CombineclearinghouseState (read liquidationPx, marginUsed, accountValue) with live LedgerLiquidation events for similar wallets to flag at-risk positions before they liquidate.
Vault leaderboards
AggregateLedgerVaultLeaderCommission and LedgerVaultDistribution events per vault address. Surface top-performing vaults by commission earned or distribution payout.
Staking and rewards tabs
Subscribe toLedgerCStakingTransfer, HypercoreDelegationEvent, and LedgerRewardsClaim for a user. Display delegation history, current stake, and rewards earned.
Borrow/lend position trackers
Filter onLedgerBorrowLend for operation: "borrow" | "repay" | "open" | "close". Display per-token borrow positions with cumulative interest.
Historical depth
Every fill, funding payment, and ledger event is retained back to HyperCore block 676,607,001 (2025-07-27T01:49:59Z). For warehouse delivery - every ledger event landing in your database continuously - use the Pipeline API (hl_misc_events).