info
endpoint with type: "userVaultEquities"
retrieves detailed information about a user’s equity positions across all vaults they have invested in on the Hyperliquid exchange. This endpoint provides comprehensive investment tracking including current values, profit/loss metrics, and withdrawal details for each vault position.
Get your own node endpoint todayStart for free and get your app to production levels immediately. No credit card required.You can sign up with your GitHub, X, Google, or Microsoft account.
Parameters
Request body
type
(string, required) — The request type. Must be"userVaultEquities"
to retrieve user’s vault equity positions.user
(string, required) — Address in 42-character hexadecimal format (e.g.,0x2b804617c6f63c040377e95bb276811747006f4b
).
Response
The response is an array of vault equity objects representing each vault investment:Response structure
Each vault equity object contains:vaultAddress
(string) — Contract address of the vault (42-character hexadecimal)equity
(string) — Current total equity value of the user’s position in USD
Understanding vault equity
Equity value:- Represents the current total value of the user’s investment in the vault
- Reflects real-time value based on vault performance and share pricing
- Calculated internally by the vault based on the user’s share ownership
- Each vault investment is tracked separately by vault address
- Equity values change based on vault performance and market conditions
- Values are denominated in USD for easy comparison and analysis
- Vault addresses uniquely identify each vault investment
- Can be used with other endpoints (like
vaultDetails
) to get additional vault information - Allows tracking of investments across multiple vault positions
Example request
Shell
Example response
Use cases
Theinfo
endpoint with type: "userVaultEquities"
is essential for applications that need to:
- Portfolio tracking: Monitor all vault investments and their current values
- Investment overview: Get a consolidated view of vault equity positions
- Investment dashboards: Display vault portfolio summaries with current values
- Asset allocation analysis: Understand distribution of investments across vaults
- Investment reporting: Generate reports showing current vault equity values
- Portfolio rebalancing: Make informed decisions about vault allocations based on current equity
- Investment interfaces: Build user-friendly vault portfolio management tools
- Performance monitoring: Track vault investment values over time
- Tax reporting: Track current investment values for tax purposes
- Vault comparison: Compare equity values across different vault investments
- Risk assessment: Evaluate exposure and concentration across vault positions
- Investment analytics: Analyze vault investment distribution and values
vaultDetails
.Body
application/json