VaultInfo

Documentation for eth_defi.hyperliquid.vault.VaultInfo Python class.

class VaultInfo

Bases: object

Detailed information about a Hyperliquid vault.

This dataclass represents the response from the vaultDetails API endpoint, containing comprehensive vault metadata, follower information, and portfolio history.

Attributes summary

name

Vault display name

vault_address

Vault's blockchain address

leader

Vault manager/operator address

description

Vault description text

followers

List of vault followers (depositors)

portfolio

Portfolio history by time period

max_distributable

Maximum distributable amount (USD)

max_withdrawable

Maximum withdrawable amount (USD)

is_closed

Whether the vault has been permanently closed and is no longer operational.

allow_deposits

Whether the vault is currently accepting new deposits from followers.

relationship_type

Vault relationship type (normal, child, parent)

commission_rate

Commission rate for the vault leader (as decimal, e.g., 0.1 = 10%)

leader_fraction

Fraction of vault capital owned by the leader (e.g.

leader_commission

Leader commission value from the vaultDetails API leaderCommission field.

parent

Parent vault address if this is a child vault

Methods summary

__init__(name, vault_address, leader, ...[, ...])

name: str

Vault display name

vault_address: eth_typing.evm.HexAddress

Vault’s blockchain address

leader: eth_typing.evm.HexAddress

Vault manager/operator address

description: str

Vault description text

followers: list[eth_defi.hyperliquid.vault.VaultFollower]

List of vault followers (depositors)

portfolio: dict[str, eth_defi.hyperliquid.vault.PortfolioHistory]

Portfolio history by time period

max_distributable: decimal.Decimal

Maximum distributable amount (USD)

max_withdrawable: decimal.Decimal

Maximum withdrawable amount (USD)

is_closed: bool

Whether the vault has been permanently closed and is no longer operational.

From the Hyperliquid vaultDetails API isClosed field.

See https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint

allow_deposits: bool

Whether the vault is currently accepting new deposits from followers.

A vault can be operational (is_closed=False) but still have deposits disabled (allow_deposits=False) — the leader controls this independently.

From the Hyperliquid vaultDetails API allowDeposits field.

See https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint

relationship_type: str

Vault relationship type (normal, child, parent)

commission_rate: float | None

Commission rate for the vault leader (as decimal, e.g., 0.1 = 10%)

leader_fraction: float | None

Fraction of vault capital owned by the leader (e.g. 0.05 = 5%).

Hyperliquid requires vault leaders to maintain at least 5% of total vault capital (verified 2026-03-09). From the vaultDetails API leaderFraction field.

Source: https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/vaults/for-vault-leaders-legacy

leader_commission: float | None

Leader commission value from the vaultDetails API leaderCommission field.

The exact semantics of this field are not yet fully understood — it may represent accumulated commission in USD or an alternative commission metric.

parent: Optional[eth_typing.evm.HexAddress]

Parent vault address if this is a child vault

__init__(name, vault_address, leader, description, followers, portfolio, max_distributable, max_withdrawable, is_closed, allow_deposits, relationship_type, commission_rate=None, leader_fraction=None, leader_commission=None, parent=None)
Parameters
Return type

None