Contents

Wallet detail

One tracked Hyperliquid wallet: stored account data, current positions (largest first), latest position events (increase / decrease kept 90 days, the other kinds 400 days) and totals.

GET/api/v1/wallets/{address}Every key

Description

404 when the wallet is not tracked.

Who can call it

Available with every key and keyless (X-Blockmetric-Access: public). Keys of Free accounts get free-tier data (real-time feeds, 30 days of history, heatmap over time for every coin over the last 24 hours, liquidation levels now for every coin, the same as the free web plan); Pro and Desk keys the data of their plan; API Dev / API Pro raise the limits.

No key
24 h
Free
30 days
Pro
365 days
Desk
1095 days
API Dev
365 days
API Pro
1095 days

History window per plan. Limits: Authentication & limits.

Parameters

Parameters of /wallets/{address}
ParameterDescription
addressstring · pathrequired0x address (40 hex characters, any case).
limitintegerNumber of position events, default 50, clamped to 1–200.1–200 · default 50

Response fields

Every success is { data, meta }; these are the fields of data. meta is the same on every endpoint.

Response fields of /wallets/{address}
FieldDescription
walletobject-
wallet.addressstringHyperliquid address, lowercase.
wallet.labelstring · nullableDisplay label: a public label with a cited source, else the self-chosen leaderboard name (unverified).
wallet.accountValuenumber · nullableAccount value (USD).
wallet.pnlMonthnumber · nullable30-day PnL (leaderboard) (USD).
wallet.vlmMonthnumber · nullable30-day volume (leaderboard) (USD).
wallet.sourcestring · nullableHow the wallet was found (e.g. hl_leaderboard).
wallet.priorityintegerPolling priority (1 = most often).
wallet.firstSeenstring (ISO 8601)First time this item was observed (ISO 8601 UTC).
wallet.lastPolledAtstring (ISO 8601) · nullableLast time the wallet was read from Hyperliquid (ISO 8601 UTC), null = not yet.
wallet.positionCountinteger · nullableNumber of open positions.
positions[]array of objectsCurrent positions, largest first.
positions[].addressstringHyperliquid address (lowercase), or with venue "lighter" the Lighter account index.
positions[].labelstring · nullableWallet label (public label or leaderboard display name).
positions[].accountValuenumber · nullableAccount value (USD).
positions[].coinstringCoin name as on Hyperliquid (BTC, kPEPE, HIP-3 names like xyz:TSLA).
positions[].side"long" | "short"Position side (for liquidations: the side of the liquidated position).
positions[].sizenumberSize in coins.
positions[].entryPxnumber · nullableEntry price.
positions[].positionUsdnumberNotional (USD).
positions[].leveragenumber · nullableLeverage of the position (notional / margin).
positions[].leverageTypestring · nullablecross | isolated
positions[].liqPxnumber · nullableLiquidation price.
positions[].liqDistancenumber · nullableSigned distance from the mark to the liquidation price, fraction (−0.12 = 12 % below the mark).
positions[].marknumber · nullableHyperliquid mark price.
positions[].marginUsednumber · nullableMargin used (USD).
positions[].unrealizedPnlnumber · nullableUnrealised PnL (USD).
positions[].updatedAtstring (ISO 8601)Newest data time of this item (ISO 8601 UTC).
positions[].venue"hyperliquid" | "lighter"Venue of the position (present for Lighter rows; absent = Hyperliquid).
events[]array of objectsLatest position events, newest first.
events[].idintegerStable id of the item; on paginated feeds the order key together with ts.
events[].tsstring (ISO 8601)Time of the event (ISO 8601 UTC).
events[].addressstringHyperliquid address, lowercase.
events[].labelstring · nullableDisplay label: a public label with a cited source, else the self-chosen leaderboard name (unverified).
events[].coinstringCoin name as on Hyperliquid (BTC, kPEPE, HIP-3 names like xyz:TSLA).
events[].kind"open" | "close" | "increase" | "decrease" | "flip" | "liquidated"Kind of whale position change (liquidated = confirmed by the wallet’s Hyperliquid liquidation fills).
events[].side"long" | "short" · nullablePosition side (long / short); for trades and orders the side named in the description.
events[].sizeDeltanumber · nullableChange in coins.
events[].usdDeltanumber · nullableChange (USD).
events[].pricenumber · nullablePrice in the quote currency of the venue (USD / USDT / USDC).
events[].dataanyKind-specific details (JSON) or null.
totalsobjectSums over the rows of this object.
totals.positionUsdnumberOpen notional (USD).
totals.longUsdnumberLong notional (USD).
totals.shortUsdnumberShort notional (USD).
totals.unrealizedPnlnumberUnrealised PnL summed over the positions that report one (USD).
totals.unrealizedPnlMissingintegerPositions without a reported unrealised PnL (left out of unrealizedPnl, not counted as 0).

Errors

Code snippets in these docs are licensed under MIT-0: copy them into your own code without attribution. The SDKs, CLI and MCP server will be, once published, Apache-2.0; the name Blockmetric is not licensed (forks must be renamed). Data from the API is governed by the API terms; third-party exchange data by the exchange’s terms.

LiveHyperliquid markets 8sOperationalHyperliquid positions & whales 8sOperationalLiquidation heatmap & levels 11sOperationalLighter markets & liquidations 17sOperationalLighter positions & heatmap 9sOperationalLighter RH positions & heatmap 13sOperationalBinance markets 38sOperationalBybit markets 8sOperationalBinance liquidations 17sOperationalBybit liquidations 17sOperationaldYdX positions & heatmap 10sOperationalGMX positions & heatmap 13sOperationalLong/short & open interest history 2mOperationalOrder books & trade flow 7sOperationalOn-chain transfers 9sOperationalSecurity monitor 47sOperationalBlockmetric Sentiment 9mOperationalOfficial news 8mOperationalAlert delivery 9sOperational10:06:35 UTCData: Blockmetric Research · Binance · Bybit