PerpClearinghouseState

Documentation for eth_defi.hyperliquid.api.PerpClearinghouseState Python class.

class PerpClearinghouseState

Bases: object

Perpetual account state for a HyperCore user.

Returned by fetch_perp_clearinghouse_state().

Attributes summary

margin_summary	Cross-margin summary
withdrawable	Withdrawable balance
asset_positions	Active perpetual positions

Methods summary

__init__(margin_summary, withdrawable, ...)

margin_summary: eth_defi.hyperliquid.api.MarginSummary

Cross-margin summary

withdrawable: decimal.Decimal

Withdrawable balance

asset_positions: list[eth_defi.hyperliquid.api.AssetPosition]

Active perpetual positions

__init__(margin_summary, withdrawable, asset_positions)

Parameters

• margin_summary (eth_defi.hyperliquid.api.MarginSummary) –

• withdrawable (decimal.Decimal) –

• asset_positions (list[eth_defi.hyperliquid.api.AssetPosition]) –

Return type

None