VaultSummary

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

class VaultSummary

Bases: object

Summary information for a Hyperliquid vault.

Contains both basic vault metadata and performance metrics from the stats-data endpoint.

Attributes summary

name

Vault display name

vault_address

Vault's blockchain address

leader

Vault manager/operator address

tvl

Total Value Locked (USD)

is_closed

Permanent closure from isClosed, or unknown when the flag is omitted.

relationship_type

Vault relationship type (normal, child, parent)

create_time

Vault creation timestamp

apr

Annual Percentage Rate (as decimal, e.g., 0.15 = 15%)

pnl_day

PNL history for daily period (list of decimal strings)

pnl_week

PNL history for weekly period (list of decimal strings)

pnl_month

PNL history for monthly period (list of decimal strings)

pnl_all_time

PNL history for all-time period (list of decimal strings)

Methods summary

__init__(name, vault_address, leader, tvl, ...)

name: str

Vault display name

vault_address: eth_typing.evm.HexAddress

Vault’s blockchain address

leader: eth_typing.evm.HexAddress

Vault manager/operator address

tvl: decimal.Decimal

Total Value Locked (USD)

is_closed: Optional[bool]

Permanent closure from isClosed, or unknown when the flag is omitted.

relationship_type: str

Vault relationship type (normal, child, parent)

create_time: Optional[datetime.datetime]

Vault creation timestamp

apr: Optional[float]

Annual Percentage Rate (as decimal, e.g., 0.15 = 15%)

pnl_day: Optional[list[str]]

PNL history for daily period (list of decimal strings)

pnl_week: Optional[list[str]]

PNL history for weekly period (list of decimal strings)

pnl_month: Optional[list[str]]

PNL history for monthly period (list of decimal strings)

pnl_all_time: Optional[list[str]]

PNL history for all-time period (list of decimal strings)

__init__(name, vault_address, leader, tvl, is_closed, relationship_type, create_time=None, apr=None, pnl_day=None, pnl_week=None, pnl_month=None, pnl_all_time=None)
Parameters
Return type

None