NetflowMetrics

Documentation for eth_defi.research.vault_metrics.NetflowMetrics Python class.

class NetflowMetrics

Bases: object

Deposit and withdrawal flow metrics for a time period.

Aggregates daily deposit/withdrawal event counts and USD values over a given period (e.g. "1d", "7d", "30d").

Only available for chains that support vault flow tracking (currently Hyperliquid). For other chains this will be None in the vault record.

Attributes summary

period

Period label (e.g.

deposit_count

Number of deposit events in the period

withdrawal_count

Number of withdrawal events in the period

deposit_usd

Total USD deposited in the period

withdrawal_usd

Total USD withdrawn in the period (positive value)

net_flow_usd

Net flow (deposit_usd - withdrawal_usd)

Methods summary

__init__(period[, deposit_count, ...])

period: str

Period label (e.g. "1d", "7d", "30d")

deposit_count: int

Number of deposit events in the period

withdrawal_count: int

Number of withdrawal events in the period

deposit_usd: float

Total USD deposited in the period

withdrawal_usd: float

Total USD withdrawn in the period (positive value)

net_flow_usd: float

Net flow (deposit_usd - withdrawal_usd)

__init__(period, deposit_count=0, withdrawal_count=0, deposit_usd=0.0, withdrawal_usd=0.0, net_flow_usd=0.0)
Parameters
  • period (str) –

  • deposit_count (int) –

  • withdrawal_count (int) –

  • deposit_usd (float) –

  • withdrawal_usd (float) –

  • net_flow_usd (float) –

Return type

None