Interface PerpetualsAccountObject

Aggregate account-level metrics for perpetuals.

interface PerpetualsAccountObject {
    accountId: bigint;
    availableCollateral: number;
    availableCollateralUsd: number;
    positions: PerpetualsPosition[];
    totalEquityUsd: number;
    totalUnrealizedFundingsUsd: number;
    totalUnrealizedPnlUsd: number;
}

Properties

accountId: bigint

Numeric ID of the account.

availableCollateral: number

Available collateral in collateral units.

availableCollateralUsd: number

Available collateral in USD.

Per-market positions for this account.

totalEquityUsd: number

Total equity in USD.

totalUnrealizedFundingsUsd: number

Sum of unrealized funding PnL across markets.

totalUnrealizedPnlUsd: number

Sum of unrealized position PnL across markets.