fetch_user_vault_equities

Documentation for eth_defi.hyperliquid.api.fetch_user_vault_equities function.

fetch_user_vault_equities(session, user, timeout=10.0, *, deadline=None)

Fetch a user’s equity positions across all Hypercore vaults.

Calls the userVaultEquities info endpoint to retrieve the user’s current vault deposits with equity and lock-up status.

This observes current holdings without an EVM precompile. Equity includes trading PnL, so its change cannot reliably prove that a small top-up landed in a large existing position; callers must keep fill accounting separate.

Example:

from eth_defi.hyperliquid.api import fetch_user_vault_equities
from eth_defi.hyperliquid.session import create_hyperliquid_session, HYPERLIQUID_TESTNET_API_URL

# Mainnet
session = create_hyperliquid_session()
equities = fetch_user_vault_equities(session, user="0xAbc...")

# Testnet
session = create_hyperliquid_session(api_url=HYPERLIQUID_TESTNET_API_URL)
equities = fetch_user_vault_equities(session, user="0xAbc...")

Parameters

session (eth_defi.hyperliquid.session.HyperliquidSession) – Session from create_hyperliquid_session().
user (Union[eth_typing.evm.HexAddress, str]) – On-chain address (the Safe address for Lagoon vaults).
timeout (float) – HTTP request timeout in seconds.
deadline (Optional[float]) – Optional absolute monotonic deadline. Final deposit confirmation must not inherit the session’s market-data outage retry window; this selects a bounded, single-attempt public request instead.

Returns

List of vault equity positions. Empty list if the user has no vault deposits.

Return type

list[eth_defi.hyperliquid.api.UserVaultEquity]