Skip to main content
GET
Perps - Wallet Overview
  • Returns a single Hyperliquid wallet summary across perpetual trading activity.
  • Use this endpoint for equity, PnL, ROI, ROE, volume, win-rate-style, and directional overview fields exposed by the service.
  • This is the wallet summary layer, not the wallet’s per-position inventory.
  • Pair with wallet open positions when you need the exact current risk book.
  • This endpoint consumes 5 CU per request.
  • Show a trader profile summary for one perp wallet.
  • Evaluate whether a wallet is worth deeper review before loading open positions.
  • Power wallet intelligence views focused on derivatives performance and exposure.
  • Compare a shortlist of notable wallets across high-level perp metrics.
  • Pass one Hyperliquid wallet address.
  • Read the response as a summarized wallet profile across the available perp metrics.
  • If the wallet matters, continue to Perps Wallet Open Positions for actual live exposure.
  • Use overview as the lightweight profile layer and reserve position-level calls for drill-down.
  • Keep point-in-time snapshots if you need to analyze wallet performance changes over time.
  • Compare wallet-level summary with token-level market state before drawing conclusions about conviction or risk.

Authorizations

X-API-KEY
string
header
required

API key for authentication

Headers

x-perp
enum<string>
default:hyperliquid

Specify the perpetuals exchange. Currently supports hyperliquid.

Available options:
hyperliquid

Query Parameters

wallet
string
required

The address of the wallet.

Response

JSON object containing overview information of a wallet

success
boolean
required

Whether the request succeeded.

data
object
required