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

    Interface ApiPerpetualsExecutionPriceBody

    Request body for computing an execution price for a hypothetical trade using the current orderbook state and oracle prices.

    interface ApiPerpetualsExecutionPriceBody {
        basePriceFeedId: string;
        collateral: bigint;
        collateralPriceFeedId: string;
        lotSize: number;
        price?: number;
        side: PerpetualsOrderSide;
        size: bigint;
    }
    Index
    basePriceFeedId collateral collateralPriceFeedId lotSize price? side size
    basePriceFeedId: string

    Oracle ID for the base price.

    collateral: bigint

    Available collateral.

    collateralPriceFeedId: string

    Oracle ID for the collateral price.

    lotSize: number

    Lot size used to discretize the order size.

    price?: number

    Optional user-specified price constraint.

    side: PerpetualsOrderSide

    Side of the hypothetical order.

    size: bigint

    Hypothetical order size in the order's raw integer scale.

    Settings
    Member Visibility

    On This Page
    Properties