aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface ApiPerpetualsMarketsPricesResponse

    Response payload for ApiPerpetualsMarketsPricesBody.

    Returns base (index/oracle) and collateral prices, the order book mid price, and the mark price used for liquidations and risk calculations.

    interface ApiPerpetualsMarketsPricesResponse {
        marketsPrices: {
            basePrice: number;
            collateralPrice: number;
            marketId: string;
            markPrice: number;
            midPrice: number | undefined;
        }[];
    }
    Index
    marketsPrices
    marketsPrices: {
        basePrice: number;
        collateralPrice: number;
        marketId: string;
        markPrice: number;
        midPrice: number | undefined;
    }[]

    Current price records for the requested markets.

    Type Declaration

    • basePrice: number

      Latest base asset price for this market.

    • collateralPrice: number

      Latest collateral asset price used in this market.

    • marketId: string

      Identifier of the market.

    • markPrice: number

      Mark price used for liquidations and risk calculations.

      Computed as the median of the index TWAP, the current book-derived price, and the index price adjusted for funding contributions.

    • midPrice: number | undefined

      Mid price derived from the current order book.

      Calculated as the average of the best bid and best ask. undefined if either side of the book is empty.

    Settings
    Member Visibility

    On This Page
    Properties