VaultSnapshot

Documentation for eth_defi.hyperliquid.vault_scanner.VaultSnapshot Python class.

class VaultSnapshot

Bases: object

A point-in-time snapshot of a Hyperliquid vault’s state.

Contains the key metrics we want to track over time for each vault.

Attributes summary

snapshot_timestamp

When this snapshot was taken

vault_address

Vault's blockchain address

name

Vault display name

leader

Vault manager/operator address

is_closed

Whether vault is closed for deposits

allow_deposits

Whether vault allows deposits (from vaultDetails API)

relationship_type

Vault relationship type (normal, child, parent)

create_time

Vault creation timestamp

tvl

Total Value Locked (USD)

apr

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

total_pnl

All-time PnL (sum of pnl_all_time array)

follower_count

Number of followers/depositors in the vault Note: Hyperliquid API returns at most 100 followers, so this value maxes out at 100

scan_disabled_reason

Reason why this vault is disabled from future scans, or None if enabled

Methods summary

__init__(snapshot_timestamp, vault_address, ...)

snapshot_timestamp: datetime.datetime

When this snapshot was taken

vault_address: eth_typing.evm.HexAddress

Vault’s blockchain address

name: str

Vault display name

leader: eth_typing.evm.HexAddress

Vault manager/operator address

is_closed: bool

Whether vault is closed for deposits

allow_deposits: bool

Whether vault allows deposits (from vaultDetails API)

relationship_type: str

Vault relationship type (normal, child, parent)

create_time: Optional[datetime.datetime]

Vault creation timestamp

tvl: decimal.Decimal

Total Value Locked (USD)

apr: Optional[float]

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

total_pnl: Optional[decimal.Decimal]

All-time PnL (sum of pnl_all_time array)

follower_count: Optional[int]

Number of followers/depositors in the vault Note: Hyperliquid API returns at most 100 followers, so this value maxes out at 100

scan_disabled_reason: Optional[eth_defi.hyperliquid.vault_scanner.ScanDisabled]

Reason why this vault is disabled from future scans, or None if enabled

__init__(snapshot_timestamp, vault_address, name, leader, is_closed, allow_deposits, relationship_type, create_time, tvl, apr, total_pnl, follower_count, scan_disabled_reason=None)
Parameters
Return type

None