Skip to content

API ReferenceReact provider and hooksInterface

UseLiquidationDetailsResult

Properties

collateralFactor?

optional collateralFactor?: CollateralFactor | null;

error?

optional error?: Error;

isLoading

isLoading: boolean;

liquidationPrice?

optional liquidationPrice?: Price;

The pair price at which this position’s current collateral factor reaches the pair’s liquidation threshold. undefined while inputs are incomplete, and also whenever computeLiquidationPrice returns indeterminate (a 0 liquidation factor) — see its TSDoc for why that is never a divide-by-zero.


pairPrice?

optional pairPrice?: Price;

requiredCollateral?

optional requiredCollateral?: bigint;

riskFactorBasisPoints?

optional riskFactorBasisPoints?: number;

riskLevel?

optional riskLevel?: RiskLevel;

status

status: RiskFactorStatus;

Why the risk half of this result is, or is not, a number. Mirrors useRiskFactor’s status: requiredCollateral can be present while risk reads incomplete, because it needs only creditedAmount.