Skip to main content

Hyperliquid Info API

Available Types (today)

Any other type value returns {"error":"unsupported_type","type":"<the type you sent>"} with HTTP 400. Requests are not forwarded to upstream Hyperliquid.

Migration Pattern


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. Forty-nine wire-compatible type values are supported today across market metadata, user state, user history, vaults, and staking - plus nine GoldRush-native types (two batched state lookups, two builder-keyed fill feeds, a portfolio composite, an all-DEX metadata fan-out, and three completed-trade / PnL analytics products) with no upstream equivalent.

Endpoint

The most-requested reads

Most Hyperliquid apps start from the same REST calls - a user’s trades and their account state. Over the drop-in /info API that is:
  • User trades (fills) - userFills for the latest fills, or userFillsByTime for a time window (GoldRush serves these past upstream’s ~10,000-fill retention limit).
  • Perp account state - clearinghouseState for a single wallet, or batchClearinghouseState for up to 50 wallets in one request.
  • Spot balances - spotClearinghouseState, or batchSpotClearinghouseState for many wallets at once.
Every type below is called the same way - POST /info with a type field - so these are the same requests you already make against api.hyperliquid.xyz, pointed at a faster, unthrottled host.

Comparison with the public Hyperliquid API

Available types

The Info API supports the wire-compatible drop-in types below, organized by what they return. Nine GoldRush-native types (batchClearinghouseState, batchSpotClearinghouseState, builderFills, builderFillsByTime, portfolioState, allPerpMetas, userCompletedTrades, userCompletedTradesByTime, userPnlSummary) have no upstream Hyperliquid equivalent.

Market metadata

User account state

User history

Vaults & staking

Builder activity

GoldRush-native batch

If you send a type that isn’t in the table above, the response body is {"error":"unsupported_type","type":""}. Requests are not forwarded to upstream Hyperliquid.

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

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.
Moving from the public Hyperliquid /info API to GoldRush is two changes:
  1. URL - replace api.hyperliquid.xyz/info with hypercore.goldrushdata.com/info.
  2. Header - add Authorization: Bearer .
That’s it. The request body and response shape are byte-for-byte identical.

Side-by-side

cURL

Public Hyperliquid
GoldRush

JavaScript / TypeScript

Public Hyperliquid
GoldRush

Python

Public Hyperliquid
GoldRush

Behavioral notes

Things to be aware of when you cut over.

Response is byte-equal, modulo live drift

For implemented types, the response body matches Hyperliquid byte-for-byte - same keys, same nesting, same value types. Numeric fields update independently on each side, so a market-price field will diverge by tens of milliseconds, but the schema is identical.

Unsupported types return a JSON error

Types that GoldRush doesn’t natively serve return {"error":"unsupported_type","type":""} with HTTP 400. They are not forwarded to upstream Hyperliquid. See the Info API overview for the current list of supported types.

Auth errors return JSON

A missing or invalid key returns 401 with body {"error":"unauthorized"}. Public Hyperliquid has no auth and never returns 401.

Existing SDKs work after a baseUrl override

The two most-used SDKs work unchanged:
  • nomeida/hyperliquid (JavaScript)
  • hyperliquid-dex/hyperliquid-python-sdk (Python)
See SDK compatibility for the override snippets.

Authentication

The Info API uses your standard GoldRush API key. The same key works against the Foundational API. If you don’t have one yet, sign up here. Never hardcode keys in source. Use environment variables or a secrets manager.

What you gain

  • No rate limits. No 1200 weight/min cap, no per-address throttling, no IP buckets.
  • Faster reads. Sub-150 ms p50 target for warm responses; orderbook reads driven from a live WebSocket-fed cache.
  • More types. Batched user state, builder-attribution data, liquidation feed, and composites.
  • HIP-3 and HIP-4 first-class. Deployer-prefix syntax (xyz:GOLD-USDC) is supported across meta and metaAndAssetCtxs when a dex is provided.
  • One key for everything Hyperliquid. The same API key unlocks HyperEVM via the Foundational API.

The most popular Hyperliquid SDKs work against GoldRush after a one-line baseUrl override and adding an Authorization header.

JavaScript / TypeScript: nomeida/hyperliquid

Install

npm
yarn

Configure

Note: If your SDK version doesn’t expose a headers option, wrap fetch to inject the header globally before instantiating the SDK. See the patch pattern below.

Header injection fallback

Python: hyperliquid-dex/hyperliquid-python-sdk

Install

Configure

Tip: skip_ws=True is recommended when using the Info API only - it skips the WebSocket connection that the SDK opens by default to upstream Hyperliquid.

Verification

After cutover, confirm everything is wired correctly:
  1. Diff a known wallet - call clearinghouseState for the same wallet against both endpoints; the JSON shape (keys, nesting, types) should match exactly.
  2. Confirm auth - remove the API key and confirm you get a 401 with body {"error":"unauthorized"}. If you get any other response, your request isn’t reaching GoldRush.

Other SDKs

The pattern is the same for any HTTP client: override the base URL to https://hypercore.goldrushdata.com and attach Authorization: Bearer . If you run into a specific SDK that doesn’t expose either knob, email us - we’ll publish a recipe.

Hyperliquid API rate limits

The public Hyperliquid /info API is rate limited to 1200 request weight per minute per IP address. Every /info request carries a weight cost, so heavy usage - polling many wallets, refreshing market state frequently, or running a fleet of workers behind one IP - hits the cap quickly and starts getting throttled. The GoldRush Hyperliquid Info API removes this limit entirely. It’s a drop-in /info replacement on hypercore.goldrushdata.com/info with byte-for-byte identical request and response shapes, but no per-IP, per-key, or per-address rate limits.

No rate limits with GoldRush

With no weight cap and no per-IP throttling, you can:
  • Poll any user-state endpoint as fast as your code wants.
  • Open as many concurrent connections as your client supports.
  • Pull state for thousands of wallets in tight loops.
For wallet-level real-time updates without polling at all, use the walletTxs subscription instead - push-based, also no rate limits.

How caching works

Responses are served from a real-time cache that’s kept fresh by direct ingestion from Hyperliquid. The cache is transparent to your client code - same JSON in, same JSON out. You’re not rate-limited, but polling smartly saves your own bandwidth.

Watch out for client-side limits

GoldRush has no rate limits, but the rest of your stack might:
  • Browser fetch concurrency - most browsers cap at ~6 concurrent requests per host. Use connection pooling on the server side or batch requests.
  • HTTP/2 stream limits - most clients allow 100+ concurrent streams per connection by default. Bump if you’re saturating.
  • OS file descriptor limits - if you’re opening thousands of connections, raise ulimit -n.
For multi-wallet fan-out, use the batchClearinghouseState and batchSpotClearinghouseState endpoints, which accept up to 50 wallets per call. For more than 50 wallets, issue multiple calls.

Network and TLS

  • HTTP/2 keep-alive is supported and recommended.
  • TLS 1.2+ required.
  • Accept-Encoding: gzip is honored. zstd support is on the roadmap.

Need higher guarantees?

Enterprise SLA, dedicated capacity, regional pinning, and on-prem options are all available. Email sales.

Hyperliquid Info API Reference

activeAssetData | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "activeAssetData" is used to fetch a user’s active trading limits, leverage setting, available size, and mark price for a single Hyperliquid perpetual asset.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "activeAssetData", "user": "...", "coin": "ETH"}.
  • coin accepts the Hyperliquid asset identifier for the target perp market. For HIP-3 markets, pass the same dex-qualified coin string used by Hyperliquid for that asset.
  • maxTradeSzs and availableToTrade are returned as two directional decimal-string values. Preserve the upstream array order and use fixed-precision decimal handling.
  • For whole-account position and margin state, use clearinghouseState; this endpoint is scoped to one user and one active asset.
Returns per-user, per-asset trading state for one active perpetual market: the user’s leverage setting, directional max trade sizes, directional available-to-trade amounts, and the current mark price. User-keyed and coin-keyed. Use this when a trading UI needs to show how much size a wallet can open or close on a specific asset before placing an order. For full account margin and open positions, use clearinghouseState; for market metadata and asset context, use metaAndAssetCtxs.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object with the user’s active trading configuration and directional trading capacity for the requested asset.

Field descriptions

Note: Prices, sizes, and available amounts are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

allMids

fetch the current mid price for every actively traded asset in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-08

allMids | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "allMids" is used to fetch the current mid price for every actively traded asset in a single call.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "allMids"}.
  • The response is a flat map keyed by asset. Perp assets use their symbol (e.g. BTC); spot pairs are keyed as @ using the spot pair index from spotMeta.
  • The optional dex field takes a perp DEX name. It defaults to the empty string, which represents the first (native) perp DEX; pass a HIP-3 dex name to scope mids to that dex.
  • Mid prices are returned as decimal strings - keep them as strings or use a fixed-precision decimal type rather than parsing as floats.
Returns the current mid price for every actively traded asset in one call. The mid price is the midpoint between the best bid and the best ask. The payload is a single JSON object mapping each asset key to its mid price as a decimal string.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A JSON object mapping each asset key to its mid price as a decimal string.

Field descriptions

Note: All mid prices are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

candleSnapshot

fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.

fundingHistory

fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies.

l2Book

fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels.

l2BookDiffSnapshot

fetch a full-depth L2 order book snapshot for one coin, with height, epoch, and seq to bootstrap the l2BookDiff2 stream. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

allPerpMetas | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "allPerpMetas" is used to fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush-native — not part of the original Hyperliquid API. It fans meta out across every perp DEX so you get the whole map in one call.
  • The response is an array: index 0 is the native Hyperliquid perp DEX; each later entry is a HIP-3 builder-deployed perp DEX, in the same order as perpDexs.
  • For a single DEX’s metadata, use meta with the dex field — this endpoint is the heavier, all-DEX equivalent.
Returns the full universe and margin tables across every perp DEX on HyperCore. Each element carries a DEX’s universe (its perp asset definitions), its marginTables (leverage-bracket tiers), and the collateralToken index.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array with one entry per perp DEX. Index 0 is the native Hyperliquid perp DEX; later entries are the HIP-3 builder-deployed perp DEXes in perpDexs order.

Field descriptions

perpDeployAuctionStatus

fetch the current perp-deploy Dutch-auction status.

perpDexLimits

fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.

perpDexs

enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore.

meta

fetch the perpetuals universe metadata without live market context.

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

outcomeMeta

enumerate all active HIP-4 binary outcome markets on HyperCore. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

batchClearinghouseState | Hyperliquid Info API

Credit Cost: 25 per call Processing: Realtime The Hyperliquid info endpoint with type: "batchClearinghouseState" is used to fetch perpetuals account state for up to 50 wallets in a single request.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - No upstream equivalent. This endpoint exists only on hypercore.goldrushdata.com. It is not a passthrough.
  • Deduplication is case-insensitive. Two addresses that differ only in case (0xAbC... vs 0xabc...) collapse to a single slot in the output, at the position of the first occurrence in the input.
  • Order preservation. The order of slots in the response matches the order of unique wallets in the input.
  • Partial failure is normal. HTTP 200 OK is returned even when individual slots are error envelopes. Always check for the error key on each slot before using its fields.
  • No cursor or pagination. All requested wallets are fanned out in parallel. For batches larger than 50, issue multiple calls.
  • Use cases: portfolio dashboards, multi-wallet PnL aggregators, fleet-level liquidation risk monitoring, copy-trade source-wallet inventory.
Fetches perpetuals account state for 1 to 50 wallets in a single request. The standard Hyperliquid /info API is single-wallet, so polling N wallets means N round trips; this endpoint fans them out in parallel against our private node and returns a single combined response. This is a GoldRush-native extension. There is no equivalent on api.hyperliquid.xyz/info. The wrapped slots return exactly the same shape as Hyperliquid’s native single-wallet clearinghouseState, with a thin per-wallet error envelope when an individual wallet fails.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

The body is a JSON array. Element i corresponds to the i-th unique wallet in the deduplicated input order. Each element is either:
  • The raw upstream Hyperliquid response object for that wallet (success), or
  • A slot-level error object (failure for that wallet only, see below).

All success

Example success body for batchClearinghouseState with 3 wallets: one empty account, one with a single cross-margin position, one with a single isolated-margin position.

Mixed result (one wallet failed)

When a single wallet fails (upstream timeout, transport failure, parse failure, etc.), only its slot is replaced with an error object. The rest of the batch is unaffected. The HTTP status is still 200 OK.

Per-wallet error slot

clearinghouseState slot field reference

Each success slot mirrors Hyperliquid’s native clearinghouseState response: assetPositions[], crossMarginSummary, marginSummary, crossMaintenanceMarginUsed, time, withdrawable. There is no schema imposition - it’s the raw upstream object. For full per-field types and notes (including the two leverage shapes and the nullable liquidationPx), see the single-wallet endpoint:

clearinghouseState field reference

Full request and response schema for the single-wallet variant. The batch endpoint returns the same object per slot. For the canonical upstream documentation, see Hyperliquid’s Perpetuals info docs.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request.

clearinghouseState

fetch a single user’s perpetuals account state by wallet address.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

portfolioState

fetch a wallet’s perp clearinghouse state, spot balances, and account-abstraction mode in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-13

batchSpotClearinghouseState | Hyperliquid Info API

Credit Cost: 25 per call Processing: Realtime The Hyperliquid info endpoint with type: "batchSpotClearinghouseState" is used to fetch spot account balances for up to 50 wallets in a single request.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - No upstream equivalent. This endpoint exists only on hypercore.goldrushdata.com. It is not a passthrough.
  • Deduplication is case-insensitive. Two addresses that differ only in case collapse to a single slot at the position of the first occurrence in the input.
  • Order preservation. Slots in the response are in the order of unique wallets in the input.
  • Partial failure is normal. HTTP 200 OK is returned even when individual slots are error envelopes. Always check for the error key on each slot before using its fields.
  • No cursor or pagination. All requested wallets are fanned out in parallel. For batches larger than 50, issue multiple calls.
  • Use cases: token treasury monitoring, holder analytics, balance reconciliation, multi-wallet airdrop eligibility checks.
Fetches spot account state for 1 to 50 wallets in a single request. The standard Hyperliquid /info API is single-wallet; this endpoint fans the requests out in parallel against our private node and returns a combined response. This is a GoldRush-native extension. There is no equivalent on api.hyperliquid.xyz/info. The wrapped slots return exactly the same shape as Hyperliquid’s native single-wallet spotClearinghouseState, with a thin per-wallet error envelope when an individual wallet fails.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

The body is a JSON array. Element i corresponds to the i-th unique wallet in the deduplicated input order. Each element is either:
  • The raw upstream Hyperliquid response object for that wallet (success), or
  • A slot-level error object (failure for that wallet only, see below).

All success

Example success body for batchSpotClearinghouseState with 3 wallets: one empty wallet, one with a single USDC balance, one with multiple tokens including held amounts.

Mixed result (one wallet failed)

When a single wallet fails (upstream timeout, transport failure, parse failure, etc.), only its slot is replaced with an error object. The rest of the batch is unaffected. The HTTP status is still 200 OK.

Per-wallet error slot

spotClearinghouseState slot field reference

Each success slot mirrors Hyperliquid’s native spotClearinghouseState response: balances[] plus the optional tokenToAvailableAfterMaintenance field. There is no schema imposition - it’s the raw upstream object. The tokenToAvailableAfterMaintenance field is optional and only present when at least one token has a non-zero margin-deduction-aware balance. Wallets without this field can simply ignore it; absence is normal for empty or inactive wallets. For full per-field types and notes, see the single-wallet endpoint:

spotClearinghouseState field reference

Full request and response schema for the single-wallet variant. The batch endpoint returns the same object per slot. For the canonical upstream documentation, see Hyperliquid’s Spot info docs.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

batchClearinghouseState

fetch perpetuals account state for up to 50 wallets in a single request.

clearinghouseState

fetch a single user’s perpetuals account state by wallet address.

spotDeployState

fetch the spot-token deployment state and gas auction for a deployer.

portfolioState

fetch a wallet’s perp clearinghouse state, spot balances, and account-abstraction mode in a single request.

spotMeta

fetch the spot universe metadata and full token configuration without live market context. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-05-21

builderFillsByTime | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "builderFillsByTime" is used to fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush-native: No POST api.hyperliquid.xyz/info equivalent. Available only via POST hypercore.goldrushdata.com/info.
  • Each response contains at most 2,000 fills; widen the window in chunks or page by advancing startTime if you need more.
  • GoldRush serves this type from a dedicated HyperCore historical store, so windows can extend back to GoldRush’s full HyperCore coverage.
  • Use builderFills (no Time suffix) when you only need the most recent N fills without specifying a window.
Returns fills attributed to a builder address bounded by a [startTime, endTime] window in milliseconds. Use this for builder revenue reports, monthly fee reconciliation, or rebuilding historical builder order-flow. Builder-keyed. GoldRush-native as there is no upstream Hyperliquid /info equivalent. Served from a dedicated HyperCore historical store, so windows can extend back to GoldRush’s full HyperCore coverage.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of fill objects ordered by time. Each entry is a fill from an order that was routed through the builder address within the window.

Field descriptions

Note: All numeric fields (px, sz, startPosition, closedPnl, fee, builderFee) are returned as decimal strings with full upstream precision (up to 18 decimal places). Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

builderFills

fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userTwapSliceFills

fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

builderFills | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "builderFills" is used to fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush-native: No POST api.hyperliquid.xyz/info equivalent. Available only via POST hypercore.goldrushdata.com/info.
  • Each response contains at most 2,000 fills, ordered most-recent first.
  • For windowed queries for revenue reports and monthly reconciliation, use builderFillsByTime.
Returns the 2,000 most recent fills attributed to a builder address. Use this when you operate a builder code and want to inspect the order flow routed through it without specifying a time window. Builder-keyed. GoldRush-native so there is no upstream Hyperliquid /info equivalent.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of fill objects ordered most-recent-first. Each entry is a fill from an order that was routed through the builder address.

Field descriptions

Note: All numeric fields (px, sz, startPosition, closedPnl, fee, builderFee) are returned as decimal strings with full upstream precision (up to 18 decimal places). Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

builderFillsByTime

fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userTwapSliceFills

fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

candleSnapshot | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "candleSnapshot" is used to fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "candleSnapshot", "req": {...}}. Note the nested req object.
  • Each response contains at most 5,000 candles (per-response cap, not a retention limit); page by advancing startTime for longer ranges.
  • GoldRush serves candles from a dedicated HyperCore historical store, so candles older than the upstream window can extend back to GoldRush’s full HyperCore coverage.
Returns an array of OHLCV candles for a single coin and interval, bounded by a [startTime, endTime] window. Each candle carries the open/close timestamps, the coin, the interval, open/high/low/close prices, base volume, and trade count. Use it for chart backfills, indicator computation, and backtests. This is a global, non-user-keyed type. NOT LIMITED TO THE MOST RECENT 5,000 CANDLES. GoldRush serves it from a dedicated HyperCore historical store so candles older than the upstream window remain available; page through time by advancing startTime.

Endpoint

Request

The request parameters are nested inside a req object.

Example

cURL
TypeScript
Python

Response

An array of candle objects, oldest first.

Field descriptions

Note: The price and volume fields (o, c, h, l, v) are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

Paginating a large backfill

Each response returns at most 5,000 candles - a per-response cap, not a limit on how far back history goes. To backfill a range wider than 5,000 candles, page forward through time: start at your window’s startTime, then set the next request’s startTime to the last candle’s close time (T) plus one millisecond. Repeat until a response returns fewer than 5,000 candles. Because T is the inclusive close of a candle and the next candle opens at T + 1, advancing to T + 1 lands exactly on the following candle - no overlap to de-duplicate and no gaps.
TypeScript
POST https://hypercore.goldrushdata.com/info Authorization: Bearer Content-Type: application/json
TypeScript
Python

Response

Field descriptions

Note: All numeric fields below (account value, position size, prices, funding amounts, etc.) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

batchClearinghouseState

fetch perpetuals account state for up to 50 wallets in a single request.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

portfolioState

fetch a wallet’s perp clearinghouse state, spot balances, and account-abstraction mode in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

delegations | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "delegations" is used to list a user’s active HYPE staking delegations.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "delegations", "user": "..."}.
  • Returns an empty array when the user has no active delegations.
  • For staking totals use delegatorSummary; for the delegate / undelegate event history behind them, use delegatorHistory.
Returns a user’s active HYPE staking delegations - one entry per validator - with the delegated amount and the timestamp until which each delegation is locked. Use delegatorSummary for aggregate totals and delegatorHistory for the underlying event sequence.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of delegation objects, one per validator. Empty when the user has no active delegations.

Field descriptions

Note: amount is returned as a decimal string, preserving upstream precision. Do not parse it as a float.

delegatorHistory

reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary.

delegatorRewards

fetch a user’s current HYPE staking position.

delegatorSummary

get a one-shot snapshot of a user’s HYPE staking position for dashboards and portfolio overviews. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

delegatorHistory | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "delegatorHistory" is used to reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "delegatorHistory", "user": "..."}.
Returns a user’s HYPE staking event history: every delegate, undelegate, staking-account deposit, and unstake withdrawal, ordered by time. Use this to reconstruct the sequence behind the totals shown in delegatorSummary. User-keyed. Each entry carries a delta whose discriminator describes the event variant.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of staking event objects.

Field descriptions

Note: delta.delegate.amount is returned as a decimal string, preserving upstream precision. Do not parse it as a float.

delegatorRewards

fetch a user’s current HYPE staking position.

delegatorSummary

get a one-shot snapshot of a user’s HYPE staking position for dashboards and portfolio overviews.

delegations

list a user’s active HYPE staking delegations.

fundingHistory

fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

delegatorRewards | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "delegatorRewards" is used to fetch a user’s current HYPE staking position.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "delegatorSummary", "user": "..."}.
Returns a single user’s accrued HYPE staking rewards: one entry per accrual, with the timestamp, the source (delegation reward versus validator commission), and the amount. User-keyed. Use this for tax reports, reward attribution dashboards, and validator P&L; use delegatorHistory for the underlying delegate / undelegate events and delegatorSummary for current totals.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of reward entries.

Field descriptions

Note: totalAmount is returned as a decimal string, preserving upstream precision. Do not parse it as a float.

delegatorHistory

reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary.

delegatorSummary

get a one-shot snapshot of a user’s HYPE staking position for dashboards and portfolio overviews.

delegations

list a user’s active HYPE staking delegations. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

delegatorSummary | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "delegatorSummary" is used to get a one-shot snapshot of a user’s HYPE staking position for dashboards and portfolio overviews.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "delegatorSummary", "user": "..."}.
Returns a single user’s HYPE staking summary: the amount currently delegated, the amount sitting undelegated in the staking account, the total of any pending withdrawals, and how many such withdrawals are pending. User-keyed. Use this for a one-shot snapshot; for the underlying sequence of delegate / undelegate / deposit / withdrawal events, use delegatorHistory.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

Field descriptions

Note: delegated, undelegated, and totalPendingWithdrawal are returned as decimal strings. Do not parse them as floats.

delegatorHistory

reconstruct the sequence of HYPE staking events behind the totals shown in delegatorSummary.

delegatorRewards

fetch a user’s current HYPE staking position.

delegations

list a user’s active HYPE staking delegations.

userPnlSummary

fetch one aggregate PnL summary for a wallet - realized PnL, win/loss rate, volume, fees, funding, active days, and traded pairs. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

exchangeStatus | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "exchangeStatus" is used to fetch the current exchange operational status.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "exchangeStatus"}.
  • specialStatuses is null under normal operation and carries status flags only when the exchange is in a special state.
  • This is a global, non-user-keyed type; time reflects the exchange’s current clock.
Returns the current operational status of the exchange. Under normal operation specialStatuses is null; a non-null value signals that the exchange is in a special state. The time field is the exchange’s current timestamp, useful for detecting clock skew or a stalled feed.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object describing the exchange status.

Field descriptions

liquidatable

list accounts currently eligible for liquidation.

marginTable

fetch the margin-tier (leverage-bracket) table for a given margin table id.

maxBuilderFee

fetch the maximum builder fee a user has approved for a given builder.

maxMarketOrderNtls

fetch the maximum market-order notional for each leverage bucket.

validatorL1Votes

validatorL1Votes endpoint. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

extraAgents | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "extraAgents" is used to list a user’s approved API-agent wallets.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "extraAgents", "user": "..."}.
  • Returns an empty array when the user has approved no agent wallets.
  • Each agent’s validUntil is a millisecond timestamp after which the API wallet’s approval expires.
Returns the extra API-agent wallets (also called API wallets) that a master account has approved. Agent wallets can sign actions on behalf of the master without holding funds themselves; each entry carries the agent’s name, address, and approval expiry.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of agent-wallet objects. Empty when the user has approved no agents.

Field descriptions

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call.

userAbstraction

fetch a user’s account-abstraction mode.

userFees

fetch a user’s fee schedule and recent daily volume.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userRole

fetch a user’s account role.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

frontendOpenOrders | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "frontendOpenOrders" is used to fetch a user’s currently open orders enriched with frontend metadata.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "frontendOpenOrders", "user": "..."}.
  • Use frontendOpenOrders instead of openOrders when you need the trigger metadata and human-readable order type - exactly what the Hyperliquid web UI displays.
Returns a single user’s currently open orders, enriched with the frontend-only metadata the Hyperliquid web UI uses: TP/SL trigger info, whether the order is a position-level TP/SL, reduce-only flag, and the human-readable order type. User-keyed. Updated on every order placement, cancellation, or fill.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of open orders. Each order object includes the standard openOrders fields plus the frontend* enrichment fields.

Field descriptions

openOrders

list a user’s resting open orders.

historicalOrders

fetch a user’s recent orders - both open and finalized - each with its current status and status timestamp.

orderStatus

look up the status of a single order for a user, by order id (oid) or client order id (cloid).

perpsAtOpenInterestCap

list the perp assets currently at their open-interest cap. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

fundingHistory | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "fundingHistory" is used to fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "fundingHistory", "coin": "..."}.
  • Each response contains at most 500 entries per call.
  • This is market-wide funding history for a coin. For a single wallet’s actual funding payments, use userFunding instead.
  • Hyperliquid retains funding history natively back to launch.
  • For the current funding rate alongside live market context, use metaAndAssetCtxs.
Returns the sequence of applied funding intervals for a single coin within a [startTime, endTime] window. Each entry carries the funding rate that was applied and the mark-vs-oracle premium at that time. Use it for funding-rate charts, basis/carry analytics, and historical funding P&L modeling. This is a global, non-user-keyed type. Page through time by advancing startTime.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of funding-interval objects, oldest first.

Field descriptions

Note: fundingRate and premium are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

allMids

fetch the current mid price for every actively traded asset in a single call.

candleSnapshot

fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.

l2Book

fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels.

l2BookDiffSnapshot

fetch a full-depth L2 order book snapshot for one coin, with height, epoch, and seq to bootstrap the l2BookDiff2 stream. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

historicalOrders | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "historicalOrders" is used to fetch a user’s recent orders - both open and finalized - each with its current status and status timestamp.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "historicalOrders", "user": "0x..."}.
  • Returns the user’s most recent orders across every coin, open and finalized (filled, canceled, and other terminal states). For only the currently-resting orders, use openOrders or frontendOpenOrders.
  • limit caps the number returned; the default and maximum is 2000.
Returns an array of the user’s recent orders, newest-relevant first, each wrapped with the order’s terminal-or-current status and the millisecond timestamp that status was set. Use it to reconstruct recent order history, audit fills/cancels, or drive an activity view.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of order entries. Each element pairs the order with its status and the millisecond timestamp that status took effect.

Field descriptions

Note: limitPx, sz, origSz, and triggerPx are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

frontendOpenOrders

fetch a user’s currently open orders enriched with frontend metadata.

openOrders

list a user’s resting open orders.

orderStatus

look up the status of a single order for a user, by order id (oid) or client order id (cloid). See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

l2BookDiffSnapshot | Hyperliquid Info API

Processing: Realtime The Hyperliquid info endpoint with type: "l2BookDiffSnapshot" is used to fetch a full-depth L2 order book snapshot for one coin, carrying the height, epoch, and per-coin seq needed to bootstrap and align the l2BookDiff2 diff stream.
Note: - GoldRush-native. l2BookDiffSnapshot is not a POST api.hyperliquid.xyz/info method - it is served only by the GoldRush endpoint.
  • Bootstrap for l2BookDiff2. That WebSocket stream is diff-only; this endpoint provides the initial book to seed from, plus the height/epoch/seq to align the diffs onto it.
  • Full depth. Unlike the 20-level l2Book snapshot, this returns the complete resting book for the coin so your reconstruction starts from a complete state.
  • The snapshot already reflects every diff up to and including its own height (it is taken after that block is applied), so discard any diff at or below it.
Returns a point-in-time, full-depth aggregated order book for one coin - two arrays of price levels (bids first, then asks), each carrying price, resting size, and order count - together with the height, epoch, and per-coin seq that tie the snapshot to the l2BookDiff2 stream.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object. levels is a two-element array: element 0 is the bid side (descending price), element 1 is the ask side (ascending price). Each level is a {px, sz, n} object.

Field descriptions

Note: px and sz are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

Bootstrapping the l2BookDiff2 stream

Use this snapshot to seed a local book, then keep it current with the l2BookDiff2 WebSocket stream:
  1. Subscribe to l2BookDiff2 for your coin(s) and start buffering Updates.
  2. Fetch this snapshot; note height, epoch, and seq.
  3. Drop any buffered batch whose block_height ≤ height.
  4. Confirm each remaining batch’s epoch equals this snapshot’s epoch (else re-fetch).
  5. Apply diffs in order - the first for the coin has prev_seq == seq.
  6. Keep checking per-coin prev_seq continuity; on a gap or epoch change, re-fetch and re-bootstrap.

l2Book

fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels.

candleSnapshot

fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.

allMids

fetch the current mid price for every actively traded asset in a single call.

fundingHistory

fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies. See all Hyperliquid endpoints: Overview hub · Info API reference

l2Book | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "l2Book" is used to fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "l2Book", "coin": "..."}.
  • Returns at most 20 levels per side.
  • For a continuous push stream instead of polling snapshots, subscribe to the WebSocket API l2Book channel (optional wildcard coin) or the GoldRush-native l2BookDiff for incremental updates.
Returns a point-in-time aggregated order book for one coin: two arrays of price levels (bids first, then asks), each level carrying the price, the total resting size at that price, and the number of orders comprising it. Use it for a one-shot depth snapshot, spread checks, or seeding a book before switching to a diff stream.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object. levels is a two-element array: element 0 is the bid side (descending price), element 1 is the ask side (ascending price). Each level is a {px, sz, n} object.

Field descriptions

Note: px and sz are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

l2BookDiffSnapshot

fetch a full-depth L2 order book snapshot for one coin, with height, epoch, and seq to bootstrap the l2BookDiff2 stream.

allMids

fetch the current mid price for every actively traded asset in a single call.

candleSnapshot

fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.

fundingHistory

fetch a coin’s historical funding rates and premiums over a time window for funding analytics and basis strategies. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-16

l4BookSnapshot | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "l4BookSnapshot" is used to fetch a full order-level (L4) order book snapshot for one coin - every resting order, not aggregated price levels - carrying the height, epoch, and per-coin seq needed to bootstrap and align the l4BookUpdates diff stream.
Note: - GoldRush-native. l4BookSnapshot is not a POST api.hyperliquid.xyz/info method - it is served only by the GoldRush endpoint.
  • Bootstrap for l4BookUpdates. That WebSocket stream is diff-only; this endpoint provides the initial order-level book to seed from, plus the height/epoch/seq to align the diffs onto it.
  • Order-level. Unlike the aggregated l2BookDiffSnapshot, each entry is an individual order (user, oid, side, sz, tif, trigger metadata), enabling queue-position reconstruction and per-trader flow attribution.
  • Perps only. No spot or prediction-market assets.
  • The snapshot already reflects every diff up to and including its own height (it is taken after that block is applied), so discard any diff at or below it.
Returns a point-in-time, full order-level book for one coin - two arrays of individual orders (bids first, then asks, each in queue order at its price) - together with the height, epoch, and per-coin seq that tie the snapshot to the l4BookUpdates stream.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object. levels is a two-element array: element 0 is the bid side, element 1 is the ask side. Each entry is an individual order (not an aggregated level), in queue order at its price.

Field descriptions

Note: limitPx, sz, and triggerPx are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

Order object

Bootstrapping the l4BookUpdates stream

Use this snapshot to seed a local order-level book, then keep it current with the l4BookUpdates WebSocket stream:
  1. Subscribe to l4BookUpdates for your coin(s) and start buffering Updates.
  2. Fetch this snapshot; note height, epoch, and seq.
  3. Drop any buffered batch whose block_height ≤ height.
  4. Confirm each remaining batch’s epoch equals this snapshot’s epoch (else re-fetch).
  5. Apply diffs in order - the first for the coin has prev_seq == seq. Insert (new), resize (update), or delete (remove) each order by oid.
  6. Keep checking per-coin prev_seq continuity; on a gap or epoch change, re-fetch and re-bootstrap.

l2BookDiffSnapshot

fetch a full-depth L2 order book snapshot for one coin, with height, epoch, and seq to bootstrap the l2BookDiff2 stream.

candleSnapshot

fetch historical OHLCV candles for a coin and interval over a time window for charting and backtesting.

l2Book

fetch an aggregated Level-2 order book snapshot for a single coin - bids and asks as price, size, and order-count levels. See all Hyperliquid endpoints: Overview hub · Info API reference

leadingVaults | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "leadingVaults" is used to list the vaults a user leads.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "leadingVaults", "user": "..."}.
  • Returns one entry per vault the user leads (manages); the array is empty when the user leads none.
  • Each entry gives the vault’s address and name; use vaultDetails for the full breakdown.
  • User-keyed by the leader address.
Returns the vaults that a user leads (manages), as an array of entries. The array is empty when the user does not lead any vault.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of vaults the user leads. Empty when the user leads none.

Field descriptions

userVaultEquities

fetch a user’s locked vault equity positions across all vaults they have deposited into.

vaultDetails

fetch detailed information for a specific vault.

vaultSummaries

list summary information for every vault on the platform. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

liquidatable | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "liquidatable" is used to list accounts currently eligible for liquidation.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "liquidatable"}.
  • Global, non-user-keyed: it takes no user field and returns the accounts that are liquidatable at the instant of the call.
  • The array is frequently empty - eligible accounts are typically liquidated the moment they cross the threshold, so a point-in-time snapshot rarely catches an open candidate.
Returns the set of accounts currently eligible for liquidation across HyperCore. This is a global, non-user-keyed type: a single snapshot shared across all callers. Because eligible accounts are liquidated almost immediately, the result is usually an empty array.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of liquidatable-account entries. The array is empty when no account is currently eligible for liquidation, which is the common case.

Field descriptions

Note: Upstream Hyperliquid does not publish a stable, fully-specified per-entry schema for liquidatable, and the result is empty in the vast majority of calls. When the array is non-empty, each entry identifies an at-risk account by its wallet address; treat any additional per-entry fields defensively.

exchangeStatus

fetch the current exchange operational status.

marginTable

fetch the margin-tier (leverage-bracket) table for a given margin table id.

maxBuilderFee

fetch the maximum builder fee a user has approved for a given builder.

maxMarketOrderNtls

fetch the maximum market-order notional for each leverage bucket.

validatorL1Votes

validatorL1Votes endpoint. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

marginTable | Hyperliquid Info API

Credit Cost: 1 per call Processing: Batch The Hyperliquid info endpoint with type: "marginTable" is used to fetch the margin-tier (leverage-bracket) table for a given margin table id.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "marginTable", "id": ...}.
  • id is the marginTableId referenced by a meta universe entry (universe[].marginTableId), also listed inline in meta.marginTables.
  • marginTiers describes how the maximum leverage steps down as a position’s notional grows.
Returns a single margin-tier table by id. Each tier gives the lower notional bound at which it applies and the maximum leverage allowed within that tier, so maximum leverage decreases as a position’s notional grows. This is the standalone lookup for the same tables embedded in meta.marginTables.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object describing the table’s description and its ordered leverage tiers.

Field descriptions

exchangeStatus

fetch the current exchange operational status.

liquidatable

list accounts currently eligible for liquidation.

maxBuilderFee

fetch the maximum builder fee a user has approved for a given builder.

maxMarketOrderNtls

fetch the maximum market-order notional for each leverage bucket.

validatorL1Votes

validatorL1Votes endpoint. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

maxBuilderFee | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "maxBuilderFee" is used to fetch the maximum builder fee a user has approved for a given builder.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "maxBuilderFee", "user": "...", "builder": "..."}.
  • The response is a bare integer in tenths of a basis point (e.g. 10 = 1 basis point = 0.01%).
  • Returns 0 when the user has not approved any builder fee for that builder.
Returns the maximum builder fee that a user has authorized a specific builder to charge, expressed as an integer in tenths of a basis point. Builders route order flow on behalf of users and may attach a fee up to this approved ceiling; 0 means no approval is in place for that builder.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

The body is a bare integer - the approved ceiling in tenths of a basis point.

Field descriptions

maxMarketOrderNtls

fetch the maximum market-order notional for each leverage bucket.

exchangeStatus

fetch the current exchange operational status.

liquidatable

list accounts currently eligible for liquidation.

marginTable

fetch the margin-tier (leverage-bracket) table for a given margin table id.

validatorL1Votes

validatorL1Votes endpoint. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

maxMarketOrderNtls | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "maxMarketOrderNtls" is used to fetch the maximum market-order notional for each leverage bucket.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "maxMarketOrderNtls"}.
  • Each entry is a [leverage, maxNotionalUsd] tuple; the notional is a decimal string.
  • This is a global, non-user-keyed type. Buckets are ordered from highest leverage to lowest.
Returns the maximum market-order notional permitted at each leverage bucket. Each element is a [maxLeverage, maxNotional] tuple: a position running at up to maxLeverage may place a single market order of at most maxNotional USD. The cap tightens as leverage rises, bounding slippage on aggressive market orders.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of [maxLeverage, maxNotional] tuples, ordered from highest leverage to lowest.

Field descriptions

Note: The notional value in each tuple is returned as a decimal string, preserving upstream precision. Do not parse it as a float - keep it as a string or use a fixed-precision decimal type.

maxBuilderFee

fetch the maximum builder fee a user has approved for a given builder.

exchangeStatus

fetch the current exchange operational status.

liquidatable

list accounts currently eligible for liquidation.

marginTable

fetch the margin-tier (leverage-bracket) table for a given margin table id.

validatorL1Votes

validatorL1Votes endpoint. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

metaAndAssetCtxs | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "metaAndAssetCtxs" is used to fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "metaAndAssetCtxs"}.
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

Request

Example

cURL
TypeScript
Python

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.

Element 0: meta

Element 1: assetCtxs[]

Array of per-asset live context, indexed identically to universe.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

outcomeMeta

enumerate all active HIP-4 binary outcome markets on HyperCore.

meta

fetch the perpetuals universe metadata without live market context.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.

settledOutcome

retrieve resolution details for a settled HIP-4 binary outcome market on HyperCore. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

meta | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "meta" is used to fetch the perpetuals universe metadata without live market context.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "meta"}.
  • Use metaAndAssetCtxs when you also need live per-asset mark price, funding, open interest, and day volume.
  • The optional dex field takes a perp DEX name. It defaults to the empty string which represents the first perp DEX.
  • For the spot equivalent, use spotMeta.
Returns the static metadata for the entire Hyperliquid perpetuals universe: every coin’s symbol, size-decimal precision, maximum leverage, and the margin-tier table it references. Unlike metaAndAssetCtxs, this payload carries no live market data, so it is cheap to cache and changes only when listings or margin parameters change.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object describing the perp universe, the margin-tier tables it references, and the collateral token.

Field descriptions

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

outcomeMeta

enumerate all active HIP-4 binary outcome markets on HyperCore.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-13

openOrders | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "openOrders" is used to list a user’s resting open orders.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "openOrders", "user": "..."}.
  • For orders enriched with trigger metadata, TP/SL flags, and the human-readable order type shown in the Hyperliquid web UI, use frontendOpenOrders instead.
  • The optional dex field scopes the query to a HIP-3 builder DEX; the empty string (default) returns orders on the canonical Hyperliquid perp DEX.
  • For a real-time stream of order placement and cancellation events, subscribe to walletTxs.
Returns a single user’s currently resting open orders as compact rows: coin, side, limit price, remaining size, order id, placement timestamp, original size, and client order id. This is the lightweight variant - reach for frontendOpenOrders when you also need trigger conditions, reduce-only / position-TP-SL flags, and the human-readable order type.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of open-order objects. Empty when the user has no resting orders.

Field descriptions

Note: limitPx, sz, and origSz are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

frontendOpenOrders

fetch a user’s currently open orders enriched with frontend metadata.

historicalOrders

fetch a user’s recent orders - both open and finalized - each with its current status and status timestamp.

orderStatus

look up the status of a single order for a user, by order id (oid) or client order id (cloid).

perpsAtOpenInterestCap

list the perp assets currently at their open-interest cap. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

orderStatus | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "orderStatus" is used to look up the status of a single order for a user, by order id (oid) or client order id (cloid).
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "orderStatus", "user": "0x...", "oid": ...}.
  • oid accepts either a numeric order id or a client order id (cloid, a hex string).
  • If the order is not found for that user, the response is {"status": "unknownOid"} (no order field).
  • To fetch many orders at once, use historicalOrders instead.
Returns the status of one order together with the order itself. Use it to poll a specific order you placed - by its exchange oid or the cloid you supplied - without pulling the user’s whole order history.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

When the order is found, status is "order" and order contains the order plus its status. When it is not, status is "unknownOid" and there is no order.
Not found:

Field descriptions

Note: limitPx, sz, origSz, and triggerPx are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

frontendOpenOrders

fetch a user’s currently open orders enriched with frontend metadata.

historicalOrders

fetch a user’s recent orders - both open and finalized - each with its current status and status timestamp.

openOrders

list a user’s resting open orders. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

outcomeMeta | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "outcomeMeta" is used to enumerate all active HIP-4 binary outcome markets on HyperCore.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "outcomeMeta"}.
Returns the live HIP-4 outcome universe: every active binary outcome market on HyperCore with its integer outcome ID, human-readable name, structured description, and sideSpecs (Yes / No). This is a global, non-user-keyed type. A single cache entry is shared across all callers and is refreshed continuously from upstream Hyperliquid. outcomeMeta is HIP-4’s dedicated metadata type - separate from metaAndAssetCtxs, which covers perps and spot. Use it to discover live outcome IDs and compute per-side market encodings (encoding = 10 * outcome + side) before subscribing to OHLCV or fills.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

Field descriptions

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

meta

fetch the perpetuals universe metadata without live market context.

settledOutcome

retrieve resolution details for a settled HIP-4 binary outcome market on HyperCore.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

perpDeployAuctionStatus | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "perpDeployAuctionStatus" is used to fetch the current perp-deploy Dutch-auction status.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "perpDeployAuctionStatus"}.
  • Describes the current perp-deploy (HIP-3) Dutch auction: the gas price decays over durationSeconds from startGas, and currentGas is the live price a deployer would pay now.
  • currentGas is null once the auction has ended; endGas is null while the auction is still active.
  • Gas prices are decimal strings. This is a global, non-user-keyed type.
Returns the status of the current perp-deploy Dutch auction. To deploy a new HIP-3 perp DEX, a deployer pays the auction’s gas price, which decays over time from startGas. currentGas is the live price; it becomes null after the auction ends, at which point endGas records the final price.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object describing the current perp-deploy gas auction.

Field descriptions

Note: Gas prices are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

perpDexLimits

fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.

perpDexs

enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.

perpsAtOpenInterestCap

list the perp assets currently at their open-interest cap. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

perpDexLimits | Hyperliquid Info API

Credit Cost: 1 per call Processing: Batch The Hyperliquid info endpoint with type: "perpDexLimits" is used to fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "perpDexLimits", "dex": "..."}.
  • The dex field names the HIP-3 builder-deployed perp DEX to inspect. Enumerate deployed DEX names with perpDexs.
  • Returns null for a DEX that has no configured limits (including the empty-string native perp DEX).
  • coinToOiCap is an array of [coin, cap] tuples; all limit values are decimal strings.
Returns the risk limits configured for a HIP-3 builder-deployed perpetual DEX: the total open-interest cap, the per-perp open-interest size cap, the maximum transfer notional, and the per-asset open-interest caps.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object describing the DEX’s limits, or null when the DEX has no configured limits.

Field descriptions

Note: All limit values are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

perpDeployAuctionStatus

fetch the current perp-deploy Dutch-auction status.

perpDexs

enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.

perpsAtOpenInterestCap

list the perp assets currently at their open-interest cap. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

perpDexs | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "perpDexs" is used to enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "perpDexs"}.
  • The null at index 0 represents the canonical Hyperliquid perp DEX; use meta or metaAndAssetCtxs with the default dex: "" to query its universe.
  • Pass a builder DEX name from this list as the dex field on meta or metaAndAssetCtxs to fetch a specific HIP-3 perp universe.
  • assetToStreamingOiCap and assetToFundingMultiplier are [coin, value] tuple arrays scoped to that DEX.
Returns the full list of perpetual DEXes on HyperCore. Index 0 is null and represents the canonical Hyperliquid perp universe; each subsequent entry is a HIP-3 builder-deployed perp DEX, exposing its short name, full name, deployer address, oracle updater, fee recipient, per-asset streaming open-interest caps, and per-asset funding-rate multipliers. This is a global, non-user-keyed type. A single cache entry is shared across all callers and is refreshed as new HIP-3 DEXes are deployed or their parameters change.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of perpetual DEX entries. Index 0 is null and represents the canonical Hyperliquid perp universe (query it via meta / metaAndAssetCtxs with the default empty dex field). Each subsequent element is a HIP-3 builder-deployed perp DEX.

Field descriptions

perpDeployAuctionStatus

fetch the current perp-deploy Dutch-auction status.

perpDexLimits

fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.

perpsAtOpenInterestCap

list the perp assets currently at their open-interest cap. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-07

perpsAtOpenInterestCap | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "perpsAtOpenInterestCap" is used to list the perp assets currently at their open-interest cap.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "perpsAtOpenInterestCap"}.
  • While an asset is in this list it has reached its open-interest cap; orders that would increase aggregate open interest are rejected (see the openInterestCap* order-rejection reasons) until open interest falls back below the cap.
  • This is a global, non-user-keyed type refreshed continuously from upstream Hyperliquid.
Returns the list of perpetual assets that are currently at their open-interest cap, as an array of coin symbol strings. Use it to detect which markets are constrained before placing orders that would add open interest.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of coin symbol strings for the perp assets currently at their open-interest cap. Empty when no market is capped.

Field descriptions

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request.

perpDeployAuctionStatus

fetch the current perp-deploy Dutch-auction status.

perpDexLimits

fetch the open-interest, position-size, and transfer limits for a HIP-3 perp DEX.

perpDexs

enumerate every HIP-3 builder-deployed perpetual DEX on HyperCore. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

portfolioState | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "portfolioState" is used to fetch a wallet’s perp clearinghouse state, spot balances, and account-abstraction mode in a single request.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush-native composite — not part of the original Hyperliquid API. It bundles three upstream calls into one round-trip: clearinghouseState, spotClearinghouseState, and userAbstraction.
  • Pass dex to scope the perp clearinghouseState to a single HIP-3 DEX. Pass dex: "ALL_DEXES" to return the perp state across the native DEX plus every HIP-3 DEX in one call, keyed by DEX name.
  • spotClearinghouseState and userAbstraction are DEX-independent and always returned once.
Returns a single object bundling a wallet’s perp account state (clearinghouseState), spot balances (spotClearinghouseState), and account-abstraction mode (userAbstraction) — the three calls a portfolio view typically needs, in one round-trip.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An object with three keys — the perp clearinghouse state, spot clearinghouse state, and the account-abstraction mode.

Field descriptions

ALL_DEXES response

When dex: "ALL_DEXES" is passed, clearinghouseState becomes an object keyed by DEX name — the native DEX under "native" plus one key per HIP-3 DEX. spotClearinghouseState and userAbstraction are unchanged.

batchClearinghouseState

fetch perpetuals account state for up to 50 wallets in a single request.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request.

clearinghouseState

fetch a single user’s perpetuals account state by wallet address.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

settledOutcome | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "settledOutcome" is used to retrieve resolution details for a settled HIP-4 binary outcome market on HyperCore.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "settledOutcome", "outcome": }.
Returns the on-chain settlement data for a single settled HIP-4 outcome: the integer outcome ID, the resolved side, the resolution price, and the settlement timestamp. Use this once an outcome has resolved to confirm which side paid out and reconcile against your own books.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

For question-class outcomes (free-form markets resolved by an oracle question), the response also includes a question object:

Field descriptions

Note: settleFraction is returned as a decimal string with full upstream precision. Do not parse it as a float - keep it as a string or use a fixed-precision decimal type.

outcomeMeta

enumerate all active HIP-4 binary outcome markets on HyperCore.

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-19

spotClearinghouseState | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "spotClearinghouseState" is used to fetch a single user’s spot account balances by wallet address.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "spotClearinghouseState", "user": "..."}.
  • USDC balance is returned as token: 0.
Returns a single user’s spot account state - token-by-token balances and the total USD value. User-keyed. Cached and kept fresh by a per-user WebSocket subscription, so updates are sub-second after any user event.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

Field descriptions

Note: All numeric balance fields (total, hold, entryNtl) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request.

spotDeployState

fetch the spot-token deployment state and gas auction for a deployer.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

batchClearinghouseState

fetch perpetuals account state for up to 50 wallets in a single request.

clearinghouseState

fetch a single user’s perpetuals account state by wallet address. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

spotDeployState | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "spotDeployState" is used to fetch the spot-token deployment state and gas auction for a deployer.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "spotDeployState", "user": "..."}.
  • states lists the deployer’s in-progress spot-token deployments; it is empty for a user with no active deployment.
  • gasAuction describes the current spot-deploy Dutch gas auction, with gas prices returned as decimal strings.
  • User-keyed by the deployer address.
Returns the spot-token deployment state for a deployer: any in-progress token deployments (states) plus the current spot-deploy gas auction (gasAuction). Use it to track a deployer’s genesis configuration and the live gas price required to deploy a spot token.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object with the deployer’s in-progress deployments and the current gas auction. states is empty when the deployer has no active spot deployment.

Field descriptions

Note: Gas prices and genesis balances are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

spotMetaAndAssetCtxs | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "spotMetaAndAssetCtxs" is used to fetch the spot universe metadata, token configuration, and live market data in a single call.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "spotMetaAndAssetCtxs"}.
Returns a tuple [spotMeta, assetCtxs[]] covering the entire Hyperliquid spot universe - every pair’s universe entry, every token’s metadata, and a live snapshot of mark price, mid price, prior-day price, and 24-hour notional volume per pair. This is the spot counterpart of metaAndAssetCtxs. Global, non-user-keyed; a single cache entry is shared across all callers and refreshed continuously from upstream Hyperliquid.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A two-element JSON array. Element 0 is the spot universe and token metadata; element 1 is an array of per-pair live contexts indexed identically to element 0’s universe.

Element 0: spotMeta

Element 1: assetCtxs[]

Array of per-pair live context, indexed identically to universe.
Note: All numeric fields below are returned as decimal strings. Do not parse them as floats.

spotMeta

fetch the spot universe metadata and full token configuration without live market context.

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context.

outcomeMeta

enumerate all active HIP-4 binary outcome markets on HyperCore.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

spotDeployState

fetch the spot-token deployment state and gas auction for a deployer.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

spotMeta | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "spotMeta" is used to fetch the spot universe metadata and full token configuration without live market context.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "spotMeta"}.
  • Use spotMetaAndAssetCtxs when you also need live per-pair mark price, mid, and day volume.
  • For the perpetuals equivalent, use meta.
Returns the static metadata for the entire Hyperliquid spot market: the list of trading pairs (universe) and the full token registry (tokens) with each token’s decimals, on-chain identifier, and linked HyperEVM contract. Carries no live market data, so it is cheap to cache and changes only when new tokens or pairs are listed.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single JSON object with two arrays: tokens (the token registry) and universe (the tradeable pairs that reference those tokens by index).

tokens[]

universe[]

spotMetaAndAssetCtxs

fetch the spot universe metadata, token configuration, and live market data in a single call.

spotClearinghouseState

fetch a single user’s spot account balances by wallet address.

spotDeployState

fetch the spot-token deployment state and gas auction for a deployer.

batchSpotClearinghouseState

fetch spot account balances for up to 50 wallets in a single request.

meta

fetch the perpetuals universe metadata without live market context.

metaAndAssetCtxs

fetch the full Hyperliquid perpetuals market universe with live per-asset trading context. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-13

subAccounts | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "subAccounts" is used to fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "subAccounts", "user": "..."}.
Returns the sub-accounts owned by a master wallet, with each sub-account’s perp clearinghouseState and spot spotClearinghouseState inlined per slot - so a single call returns the full balance picture across the master plus its sub-accounts. User-keyed. The result is null for wallets that aren’t master accounts.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of sub-account objects, or null if the queried wallet is not a master account.

Field descriptions

extraAgents

list a user’s approved API-agent wallets.

userAbstraction

fetch a user’s account-abstraction mode.

userFees

fetch a user’s fee schedule and recent daily volume.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userRole

fetch a user’s account role.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

userAbstraction | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userAbstraction" is used to fetch a user’s account-abstraction mode.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userAbstraction", "user": "..."}.
  • The response body is a bare JSON string (for example "disabled"), not an object - parse it as a scalar.
  • Values seen in production are disabled and unifiedAccount; the wider native enum also includes portfolioMargin, default, and the legacy dexAbstraction.
Returns the account-abstraction mode configured for a wallet. The response is a single JSON string rather than an object: disabled means the account keeps separate perp and spot balances, while unifiedAccount means a single balance per asset is shared across all DEXes with cross-margin positions sharing collateral.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

The body is a bare JSON string - not an object - naming the account-abstraction mode.

Field descriptions

userFees

fetch a user’s fee schedule and recent daily volume.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userRole

fetch a user’s account role.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user.

extraAgents

list a user’s approved API-agent wallets.

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userBorrowLendInterest | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userBorrowLendInterest" is used to fetch a user’s borrow/lend interest accrual history.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userBorrowLendInterest", "user": "...", "startTime": ...}.
  • Bounded by a **startTime, endTime) window in milliseconds; endTime defaults to the current server time when omitted.
  • Amounts are decimal strings, one row per token per accrual point.
Returns a user’s borrow/lend interest accrual over a time window - the interest charged on borrowed balances and earned on supplied (lent) balances, per token. Use it for P&L attribution and accounting on Hyperliquid borrow/lend positions.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of per-token interest accrual points within the window. Empty when the user accrued no borrow/lend interest over the range.

Field descriptions

Note: borrow and supply are returned as decimal strings, preserving upstream precision. Do not parse them as floats.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userFunding

fetch a user’s per-coin funding payment history within a time window for funding-only P&L attribution.

userNonFundingLedgerUpdates

fetch a user’s non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time… See all Hyperliquid endpoints: [Overview hub** · Info API reference Last reviewed: 2026-08-17

userCompletedTradesByTime | Hyperliquid Info API

Credit Cost: 10 per call Processing: Realtime The Hyperliquid info endpoint with type: "userCompletedTradesByTime" is used to fetch a wallet’s fully-closed round-trip trades within a close-time window, oldest-first, with a keyset cursor for forward paging.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush custom analytics product. Not available on the public Hyperliquid node - there is no POST api.hyperliquid.xyz/info equivalent. Served only from POST hypercore.goldrushdata.com/info.
  • Each record is one fully-closed round-trip position (opened, then brought fully flat), reconstructed from the wallet’s fills, windowed on close_time and returned oldest-first.
  • Page forward with the keyset cursor: pass "{close_time}_{tx_index}" built from the last row of the previous page to fetch the next page. Repeat until fewer than limit records return.
  • startTime is required unless a cursor is supplied. Returns up to limit records per page (default 100, max 500).
  • For the latest N trades without a window, use userCompletedTrades. For one aggregate roll-up, use userPnlSummary.
Returns a wallet’s fully-closed round-trip trades whose close_time falls in a [startTime, endTime] window, ordered oldest-first. Each record has the same shape as userCompletedTrades plus a tx_index ordinal. Use this to walk a wallet’s full trade history forward in time - PnL recaps, tax-lot reconstruction, or backfills - paging with the keyset cursor rather than the latest N records. User-keyed. GoldRush-native, so there is no upstream Hyperliquid /info equivalent.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of completed-trade objects, oldest-first by (close_time, tx_index).

Field descriptions

Note: The PnL, price, size, and fee fields (gross_pnl, net_pnl, funding_pnl, entry_px, exit_px, position_closed_size, fees, max_position_size) are returned as decimal strings, preserving full precision. Counts (fills, maker_fills, tx_index) and timestamps (open_time, close_time, duration_ms) are JSON numbers. Do not parse the decimal strings as floats - keep them as strings or use a fixed-precision decimal type.

userCompletedTrades

fetch a wallet’s most recent fully-closed round-trip trades, newest-first, each with realized PnL, funding, fees, and volume-weighted entry/exit prices.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.

userAbstraction

fetch a user’s account-abstraction mode. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userCompletedTrades | Hyperliquid Info API

Credit Cost: 10 per call Processing: Realtime The Hyperliquid info endpoint with type: "userCompletedTrades" is used to fetch a wallet’s most recent fully-closed round-trip trades, newest-first, each with realized PnL, funding, fees, and volume-weighted entry/exit prices.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush custom analytics product. Not available on the public Hyperliquid node - there is no POST api.hyperliquid.xyz/info equivalent. Served only from POST hypercore.goldrushdata.com/info.
  • Each record is one fully-closed round-trip position (opened, then brought fully flat), reconstructed from the wallet’s fills. Positions that are still open are not included.
  • Returns up to limit records, newest-first (default 100, max 500).
  • For a close_time window with forward paging, use userCompletedTradesByTime. For one aggregate roll-up across all a wallet’s trades, use userPnlSummary.
Returns the latest limit fully-closed round-trip trades for a wallet, ordered newest-first by close time. Each row rolls up every fill that opened and then fully closed a position on one coin into a single record - realized gross and net PnL, the funding component, volume-weighted entry and exit prices, fees, fill counts, and the open/close timestamps. Use this when you want a wallet’s recent trading outcomes without stepping through raw fills. User-keyed. GoldRush-native, so there is no upstream Hyperliquid /info equivalent.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of completed-trade objects, newest-first by close_time.

Field descriptions

Note: The PnL, price, size, and fee fields (gross_pnl, net_pnl, funding_pnl, entry_px, exit_px, position_closed_size, fees, max_position_size) are returned as decimal strings, preserving full precision. Counts (fills, maker_fills) and timestamps (open_time, close_time, duration_ms) are JSON numbers. Do not parse the decimal strings as floats - keep them as strings or use a fixed-precision decimal type.

userCompletedTradesByTime

fetch a wallet’s fully-closed round-trip trades within a close-time window, oldest-first, with a keyset cursor for forward paging.

userAbstraction

fetch a user’s account-abstraction mode.

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userFees

fetch a user’s fee schedule and recent daily volume. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userFees | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userFees" is used to fetch a user’s fee schedule and recent daily volume.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userFees", "user": "..."}.
  • feeSchedule is the exchange-wide tier table; userCrossRate / userAddRate are the effective rates this user pays after VIP-tier, referral, and staking discounts.
  • All rate and volume fields are decimal strings; a rate of "0.00045" means 4.5 basis points.
Returns a user’s effective trading fees together with the exchange-wide fee schedule and the user’s recent per-day traded volume. Use it to display the taker (cross) and maker (add) rates a wallet actually pays, and to reconstruct the tier table and discounts that produce them.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object with the user’s recent daily volume, the exchange-wide feeSchedule, the user’s effective rates, and any active discounts / trial state.

Field descriptions

Note: All rate and volume fields (userCross, userAdd, exchange, cross, add, userCrossRate, userAddRate, and the tier / discount values) are returned as decimal strings. Do not parse them as floats. Rates are expressed as fractions of notional - "0.00045" = 4.5 bps.

userAbstraction

fetch a user’s account-abstraction mode.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userRole

fetch a user’s account role.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user.

extraAgents

list a user’s approved API-agent wallets.

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userFillsByTime | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userFillsByTime" is used to fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userFillsByTime", "user": "...", "startTime": ...}.
  • Each response contains at most 2,000 fills; widen the window in chunks or page by advancing startTime if you need more.
  • GoldRush serves this type from a dedicated HyperCore historical store, so windows older than upstream Hyperliquid’s 10,000-fill retention are still fulfilled.
  • Use userFills (no Time suffix) when you only need the most recent N fills without specifying a window.
Returns a single user’s fills bounded by a **startTime, endTime) window in milliseconds. Use this when you want fills since a specific moment - daily P&L recaps, post-deploy backfills, or rebuilding a tax ledger - rather than the most recent N fills. User-keyed. The upstream Hyperliquid API caps each response at 2,000 fills; page by advancing startTime. NOT LIMITED TO THE 10,000 MOST RECENT FILLS. GoldRush serves this type from a dedicated HyperCore historical store so windows extending past the upstream retention limit are fulfilled from GoldRush data rather than truncated.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of fill objects ordered by time.

Field descriptions

Note: All numeric fields (px, sz, startPosition, closedPnl, fee, builderFee) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.

userTwapSliceFills

fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders.

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userFunding

fetch a user’s per-coin funding payment history within a time window for funding-only P&L attribution.

userNonFundingLedgerUpdates

fetch a user’s non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time… See all Hyperliquid endpoints: [Overview hub** · Info API reference Last reviewed: 2026-07-23

userFills | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userFills" is used to fetch a user’s most recent trade fills without specifying a time window.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userFills", "user": "..."}.
  • Each response contains at most 2,000 fills.
Returns the most recent fills for a user, up to 2,000. Use this when you need the latest trade activity without specifying a time window. User-keyed. The upstream Hyperliquid API caps each response at 2,000 fills per wallet.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of fill objects ordered most-recent-first.

Field descriptions

Note: All numeric fields (px, sz, startPosition, closedPnl, fee, builderFee) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userTwapSliceFills

fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userFunding

fetch a user’s per-coin funding payment history within a time window for funding-only P&L attribution.

userNonFundingLedgerUpdates

fetch a user’s non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time… See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

userFunding | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userFunding" is used to fetch a user’s per-coin funding payment history within a time window for funding-only P&L attribution.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userFunding", "user": "..."}.
Returns a single user’s funding payment history within a [startTime, endTime) window. Each entry is one funding application: a coin, the rate that was applied, the position size at the time, and the resulting USDC delta (negative = paid, positive = received). User-keyed. Use this for funding-only P&L attribution; use userNonFundingLedgerUpdates for everything else.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of funding event objects, one per applied funding interval and coin.

Field descriptions

Note: All numeric delta fields are returned as decimal strings. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userNonFundingLedgerUpdates

fetch a user’s non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time…

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

userNonFundingLedgerUpdates | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userNonFundingLedgerUpdates" is used to fetch a user’s non-funding USDC ledger history (deposits, withdrawals, transfers, vault flows) within a time window.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userNonFundingLedgerUpdates", "user": "..."}.
  • Funding payments are not included here - use userFunding.
Returns a single user’s USDC and account ledger history within a [startTime, endTime) window, excluding funding payments. Funding events are intentionally separated into their own type, userFunding, so applications can render fee accruals separately from balance-moving events. User-keyed. Each entry carries a delta whose type discriminates the event variant - deposits, withdrawals, internal transfers, sub-account transfers, vault flows, liquidations, rewards claims, and similar.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of ledger event objects. Each entry has time, hash, and a delta discriminated by delta.type.

Field descriptions

Note: All numeric delta fields are returned as decimal strings. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userFunding

fetch a user’s per-coin funding payment history within a time window for funding-only P&L attribution.

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-20

userPnlSummary | Hyperliquid Info API

Credit Cost: 10 per call Processing: Realtime The Hyperliquid info endpoint with type: "userPnlSummary" is used to fetch one aggregate PnL summary for a wallet - realized PnL, win/loss rate, volume, fees, funding, active days, and traded pairs.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - GoldRush custom analytics product. Not available on the public Hyperliquid node - there is no POST api.hyperliquid.xyz/info equivalent. Served only from POST hypercore.goldrushdata.com/info.
  • Returns a single aggregate object for one wallet (not an array), rolled up from the wallet’s fully-closed round-trip trades and trading activity.
  • startTime / endTime are optional. When supplied they window the realized metrics; accountAgeDays and tradedPairs are always lifetime.
  • dex scopes the trade aggregates and tradedPairs; volumeTraded, daysActive, and accountAgeDays are computed across all DEXes.
  • For the underlying per-trade rows behind these totals, use userCompletedTrades or userCompletedTradesByTime.
Returns a single aggregate object summarizing a wallet’s realized trading performance - net PnL, win and loss rates, trade count, notional volume, fees, funding, active-day count, account age, and the list of coins it has traded. Use this for leaderboard tiles, wallet profile headers, or a one-call PnL read instead of paging through completed trades. User-keyed. GoldRush-native, so there is no upstream Hyperliquid /info equivalent.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single aggregate object for the wallet.

Field descriptions

Note: totalPnl, totalFees, and totalFunding are decimal strings (full precision); volumeTraded is a fixed 2-decimal string. winRate and lossRate are JSON floats (4 decimals). totalTrades, daysActive, and accountAgeDays are JSON numbers. Do not parse the decimal strings as floats - keep them as strings or use a fixed-precision decimal type.

userAbstraction

fetch a user’s account-abstraction mode.

userBorrowLendInterest

fetch a user’s borrow/lend interest accrual history.

userCompletedTrades

fetch a wallet’s most recent fully-closed round-trip trades, newest-first, each with realized PnL, funding, fees, and volume-weighted entry/exit prices.

userCompletedTradesByTime

fetch a wallet’s fully-closed round-trip trades within a close-time window, oldest-first, with a keyset cursor for forward paging. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userRateLimit | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userRateLimit" is used to fetch a user’s API rate-limit usage and cap.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userRateLimit", "user": "..."}.
  • This reports Hyperliquid’s own address-based L1 request allowance; it is unrelated to your GoldRush credit budget.
  • The request cap (nRequestsCap) is a function of the account’s cumulative traded volume (cumVlm), so higher-volume accounts are granted more requests.
Returns the address-based API rate-limit accounting Hyperliquid maintains for a wallet: cumulative traded volume, how many requests have been used, the current cap, and any surplus beyond it. Use it to monitor how much of an account’s request allowance remains.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

Field descriptions

Note: cumVlm is returned as a decimal string. Do not parse it as a float.

userAbstraction

fetch a user’s account-abstraction mode.

userFees

fetch a user’s fee schedule and recent daily volume.

userRole

fetch a user’s account role.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user.

extraAgents

list a user’s approved API-agent wallets.

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userRole | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userRole" is used to fetch a user’s account role.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userRole", "user": "..."}.
  • The role value is one of missing, user, agent, vault, or subAccount.
  • The subAccount and agent roles additionally carry a data object identifying the controlling master account.
Returns the role a wallet plays on HyperCore. Most trading wallets are plain user accounts; this type also distinguishes API agent wallets, vault addresses, and subAccounts. For a subAccount (and for an agent), a nested data object carries the master account address that controls the wallet.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object with a role discriminator. A plain trading wallet returns {"role": "user"}; a sub-account additionally returns its controlling master under data.

Field descriptions

userAbstraction

fetch a user’s account-abstraction mode.

userFees

fetch a user’s fee schedule and recent daily volume.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userToMultiSigSigners

fetch the authorized signers for a multi-sig user.

extraAgents

list a user’s approved API-agent wallets.

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userToMultiSigSigners | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userToMultiSigSigners" is used to fetch the authorized signers for a multi-sig user.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userToMultiSigSigners", "user": "..."}.
  • Returns null when the queried wallet is not a multi-sig account.
  • A multi-sig account has at most 10 authorized signers; threshold is the minimum number that must sign to authorize an action.
Returns the authorized-signer configuration for a wallet that has been converted to a multi-sig account: the set of addresses allowed to sign for it, and the minimum number of signatures (threshold) required to authorize an action. Returns null for ordinary (non-multi-sig) wallets.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An object describing the multi-sig signer set, or null when the queried wallet is not a multi-sig account.

Field descriptions

userAbstraction

fetch a user’s account-abstraction mode.

userFees

fetch a user’s fee schedule and recent daily volume.

userRateLimit

fetch a user’s API rate-limit usage and cap.

userRole

fetch a user’s account role.

extraAgents

list a user’s approved API-agent wallets.

subAccounts

fetch a master wallet’s sub-accounts along with their full perp and spot state in a single call. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

userTwapSliceFillsByTime | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userTwapSliceFillsByTime" is used to fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userTwapSliceFillsByTime", "user": "...", "startTime": ...}.
  • Each response contains at most 2,000 slice fills; widen the window in chunks or page by advancing startTime if you need more.
  • GoldRush serves this type from a dedicated HyperCore historical store, so windows older than upstream Hyperliquid’s 10,000-fill retention are still fulfilled.
  • TWAP slice fills have a hash of all zeros - use that, or the presence of twapId, to distinguish them from regular fills.
  • Use userTwapSliceFills (no ByTime suffix) when you only need the most recent N slice fills without specifying a window.
Returns a single user’s TWAP slice fills bounded by a **startTime, endTime) window in milliseconds. Each entry is a {fill, twapId} pair, where twapId ties the slice back to its parent TWAP order. Use this when you want execution-quality data for TWAP orders within a specific window - daily slice recaps, post-deploy backfills, or reconciling realized TWAP execution against benchmarks. User-keyed. The upstream Hyperliquid API caps each response at 2,000 slice fills; page by advancing startTime. NOT LIMITED TO THE 10,000 MOST RECENT FILLS. GoldRush serves this type from a dedicated HyperCore historical store so windows extending past the upstream retention limit are fulfilled from GoldRush data rather than truncated.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of TWAP slice fill objects ordered by time.

Field descriptions

Note: All numeric fill fields (px, sz, startPosition, closedPnl, fee) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userTwapSliceFills

fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

userFills

fetch a user’s most recent trade fills without specifying a time window.

builderFillsByTime

fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting.

builderFills

fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-19

userTwapSliceFills | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userTwapSliceFills" is used to fetch a user’s most recent TWAP slice fills for execution-quality analytics on algorithmic orders.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userTwapSliceFills", "user": "..."}.
  • Each response contains at most 2,000 most recent TWAP slice fills. Older slices beyond that window are not retrievable from this endpoint.
  • TWAP slice fills have a hash of all zeros - use that, or the presence of twapId, to distinguish them from regular fills.
  • Use userFillsByTime when you want all fills (regular + TWAP slices) for a wallet within a time window; each TWAP slice there carries the same twapId field.
Returns a single user’s most recent TWAP slice fills - each individual slice executed as part of a larger TWAP (Time-Weighted Average Price) order. Every entry is a {fill, twapId} pair, where twapId ties the slice back to its parent TWAP order. Multiple slices from the same TWAP share the same twapId. User-keyed. Use this when you want execution-quality data for TWAP orders specifically - slippage per slice, fills-per-TWAP, realized average price - rather than the unified fills feed from userFillsByTime.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of TWAP slice fill objects, most recent first.

Field descriptions

Note: All numeric fill fields (px, sz, startPosition, closedPnl, fee) are returned as decimal strings, preserving upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type.

userTwapSliceFillsByTime

fetch a user’s TWAP slice fills within a time window for execution-quality reconciliation on algorithmic orders.

userFills

fetch a user’s most recent trade fills without specifying a time window.

userFillsByTime

fetch a user’s trade fills within a time window for P&L recaps and tax ledger reconstruction.

builderFills

fetch a builder’s most recent attributed trade fills for revenue attribution and order-flow analytics.

builderFillsByTime

fetch a builder’s attributed trade fills within a time window for revenue attribution and fee accounting. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-13

userVaultEquities | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "userVaultEquities" is used to fetch a user’s locked vault equity positions across all vaults they have deposited into.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "userVaultEquities", "user": "..."}.
Returns the wallet’s per-vault equity: one entry per vault the user has deposited into, with the locked amount and the timestamp at which that equity becomes unlockable. User-keyed. The result is [] for wallets that haven’t deposited into any vault.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of vault equity entries.

Field descriptions

Note: equity is returned as a decimal string, preserving upstream precision. Do not parse it as a float - keep it as a string or use a fixed-precision decimal type.

vaultDetails

fetch detailed information for a specific vault.

vaultSummaries

list summary information for every vault on the platform.

leadingVaults

list the vaults a user leads. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-07-23

validatorL1Votes | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "validatorL1Votes"}.
  • Each entry is an L1 governance action currently awaiting validator votes, with an expireTime (ms) after which the pending vote lapses.
  • The action object is a tagged variant; its inner shape depends on the specific L1 action being voted on (the example below shows a settleOutcome action).
  • This is a global, non-user-keyed type.
Returns the pending validator L1 governance votes - the L1 actions currently awaiting validator approval. Each entry pairs an expireTime with the action under vote.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of pending L1 action votes. Empty when no L1 action is awaiting votes.

Field descriptions

exchangeStatus

fetch the current exchange operational status.

liquidatable

list accounts currently eligible for liquidation.

marginTable

fetch the margin-tier (leverage-bracket) table for a given margin table id.

maxBuilderFee

fetch the maximum builder fee a user has approved for a given builder.

maxMarketOrderNtls

fetch the maximum market-order notional for each leverage bucket. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

vaultDetails | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "vaultDetails" is used to fetch detailed information for a specific vault.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "vaultDetails", "vaultAddress": "..."}.
  • vaultAddress is required; the optional user field populates followerState with that wallet’s position in the vault.
  • portfolio is an array of [period, series] pairs bucketed by day, week, month, allTime, and their perp* variants.
  • Aggregate stats (apr, leaderFraction, leaderCommission, maxDistributable, maxWithdrawable) are JSON numbers, while position, equity, and history values are decimal strings.
  • For a lightweight list across all vaults, use vaultSummaries.
Returns the full detail for a single vault: identity (name, address, leader, description), time-bucketed performance history (portfolio), headline stats (apr, distributable and withdrawable amounts), the follower roster, and the vault’s relationship to any parent or child vaults.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

A single object describing the vault.

Field descriptions

Note: Position, equity, and history values (portfolio account-value/PnL samples, vlm, and follower vaultEquity/pnl/allTimePnl) are returned as decimal strings. The aggregate stats apr, leaderFraction, leaderCommission, maxDistributable, and maxWithdrawable are returned as JSON numbers.

vaultSummaries

list summary information for every vault on the platform.

userVaultEquities

fetch a user’s locked vault equity positions across all vaults they have deposited into.

leadingVaults

list the vaults a user leads. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

vaultSummaries | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "vaultSummaries" is used to list summary information for every vault on the platform.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "vaultSummaries"}.
  • Returns one entry per vault on the platform. The array may be empty depending on platform state.
  • relationship.type distinguishes standalone vaults ("normal") from parent/child vault relationships.
  • This is a global, non-user-keyed type; tvl is a decimal string.
  • For a single vault’s full breakdown (portfolio history, followers, APR), use vaultDetails.
Returns summary information for every vault on the platform, one entry per vault: its name, address, leader, total value locked, closed flag, relationship type, and creation time. Use vaultDetails for a single vault’s full breakdown.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

An array of vault-summary objects, one per vault. May be empty depending on platform state.

Field descriptions

Note: tvl is returned as a decimal string, preserving upstream precision. Do not parse it as a float - keep it as a string or use a fixed-precision decimal type.

vaultDetails

fetch detailed information for a specific vault.

userVaultEquities

fetch a user’s locked vault equity positions across all vaults they have deposited into.

leadingVaults

list the vaults a user leads. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-08-17

webData2 | Hyperliquid Info API

Credit Cost: 1 per call Processing: Realtime The Hyperliquid info endpoint with type: "webData2" is used to fetch the composite snapshot the Hyperliquid web app uses for a wallet in a single call.
Tip: Estimate your monthly cost for this API using the Pricing Calculator.
Note: - Wire-equal to POST api.hyperliquid.xyz/info with {"type": "webData2", "user": "0x..."}.
Returns the same composite payload the Hyperliquid web frontend pulls on page load for a given wallet: perp clearinghouse state, spot balances, open orders with trigger metadata, recent fills, and assorted UI-side context. User-keyed. Use this when you want a single round-trip to populate a dashboard for a wallet.

Endpoint

Request

Example

cURL
TypeScript
Python

Response

The response is a single composite object. The example below shows one representative element of each array; in practice meta.universe, assetCtxs, spotAssetCtxs, and openOrders each contain many entries.

Field descriptions

Note: All numeric balances, prices, and sizes are returned as decimal strings with full upstream precision. Do not parse them as floats - keep them as strings or use a fixed-precision decimal type. Timestamps (serverTime, time, timestamp) are integer Unix milliseconds.

activeAssetData

fetch a user’s active trading limits, leverage setting, available size, and mark price for a single Hyperliquid perpetual…

allMids

fetch the current mid price for every actively traded asset in a single call.

allPerpMetas

fetch the perpetuals metadata — universe definitions and margin tables — for every perp DEX in a single request. See all Hyperliquid endpoints: Overview hub · Info API reference Last reviewed: 2026-06-19