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. Sources that expose monetary counters but not individual events retain null counts.

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)

data_complete

Whether every daily monetary observation in the full period is known.

Methods summary

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

period: str

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

deposit_count: Optional[int]

Number of deposit events in the period

withdrawal_count: Optional[int]

Number of withdrawal events in the period

deposit_usd: Optional[float]

Total USD deposited in the period

withdrawal_usd: Optional[float]

Total USD withdrawn in the period (positive value)

net_flow_usd: Optional[float]

Net flow (deposit_usd - withdrawal_usd)

data_complete: bool

Whether every daily monetary observation in the full period is known.

__init__(period, deposit_count=None, withdrawal_count=None, deposit_usd=None, withdrawal_usd=None, net_flow_usd=None, data_complete=False)
Parameters
Return type

None