Retrieve detailed information about a specific vault including portfolio performance, followers, leader information, and vault configuration settings.
info
endpoint with type: "vaultDetails"
retrieves comprehensive information about a specific vault on the Hyperliquid exchange. This endpoint provides detailed vault metrics including portfolio performance, follower information, leader details, and vault configuration settings, enabling thorough analysis of vault operations and performance.
type
(string, required) — The request type. Must be "vaultDetails"
to retrieve vault details.vaultAddress
(string, required) — Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000.user
(string, optional) — Address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000.name
— The vault’s display namevaultAddress
— The vault’s blockchain addressleader
— Address of the vault leader/managerdescription
— Detailed description of the vault’s strategy and purposeportfolio
— Array of portfolio performance data across different time periodsapr
— Annual percentage return as a decimalleaderFraction
— Fraction of the vault controlled by the leaderleaderCommission
— Commission rate charged by the leaderfollowers
— Array of follower objects with detailed equity and performance datafollowerState
— State information for followers (null if not applicable)maxDistributable
— Maximum amount that can be distributedmaxWithdrawable
— Maximum amount that can be withdrawnisClosed
— Boolean indicating if the vault is closed to new depositsallowDeposits
— Boolean indicating if new deposits are allowedalwaysCloseOnWithdraw
— Boolean indicating if positions are always closed on withdrawalrelationship
— Object describing parent/child vault relationshipsportfolio
array contains performance data across different time periods:
Time period identifiers:
"day"
— Daily performance data"week"
— Weekly performance data"month"
— Monthly performance data"allTime"
— All-time performance data"perpDay"
— Daily perpetual trading performance"perpWeek"
— Weekly perpetual trading performance"perpMonth"
— Monthly perpetual trading performance"perpAllTime"
— All-time perpetual trading performanceaccountValueHistory
— Array of [timestamp, value] pairs showing account value over timepnlHistory
— Array of [timestamp, pnl] pairs showing profit/loss over timevlm
— Volume metric for the perioduser
— Follower’s wallet addressvaultEquity
— Current equity value in the vaultpnl
— Current profit and lossallTimePnl
— All-time profit and loss since joiningdaysFollowing
— Number of days the user has been following the vaultvaultEntryTime
— Timestamp when the user entered the vault (milliseconds)lockupUntil
— Timestamp until which funds are locked (milliseconds)relationship
object describes vault hierarchies:
Parent vault:
type: "parent"
— Indicates this vault has child vaultsdata.childAddresses
— Array of child vault addressestype: "child"
— Indicates this vault has a parent vaultdata.parentAddress
— Parent vault addressmaxDistributable
shows available funds for distributionmaxWithdrawable
indicates immediate withdrawal capacityinfo
endpoint with type: "vaultDetails"
is essential for applications that need to:
Successful response with vault details
The response is of type object
.