aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface PerpetualsMarketData

    Aggregate market configuration and state for a single perpetuals market.

    interface PerpetualsMarketData {
        collateralCoinType: string;
        collateralPrice: number;
        estimatedFundingRate: number;
        indexPrice: number;
        marketParams: PerpetualsMarketParams;
        marketState: PerpetualsMarketState;
        markPrice?: number;
        nextFundingTimestampMs: bigint;
        objectId: string;
        packageId: string;
    }
    Index
    collateralCoinType collateralPrice estimatedFundingRate indexPrice marketParams marketState markPrice? nextFundingTimestampMs objectId packageId
    collateralCoinType: string

    Collateral coin type used for margin in this market.

    collateralPrice: number

    Current price of collateral in USD or the platform's base unit.

    estimatedFundingRate: number

    Estimated funding rate for the next funding interval.

    indexPrice: number

    Oracle/index price of the base asset for this market.

    marketParams: PerpetualsMarketParams

    Static configuration parameters for this market.

    marketState: PerpetualsMarketState

    Dynamic runtime state (funding, open interest, etc.).

    markPrice?: number

    Price positions are marked against for PnL and liquidation, as opposed to the raw index.

    Only the websocket market stream carries this. REST responses are built from an indexer payload that has no mark price, so the field is absent there rather than reported as null.

    nextFundingTimestampMs: bigint

    Timestamp (ms) for the next funding event, as a bigint.

    objectId: string

    Object ID for the market (clearing house) on-chain.

    packageId: string

    Package ID of the deployed perpetuals contract.

    Settings
    Member Visibility

    On This Page
    Properties