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

    Interface ApiPerpetualsMaxOrderSizeBody

    Request body for computing the maximum order size for an account in a given market.

    interface ApiPerpetualsMaxOrderSizeBody {
        accountId: bigint;
        builderCode?: PerpetualsBuilderCodeParamaters;
        leverage?: number;
        marketId: string;
        price?: number;
        side: PerpetualsOrderSide;
    }
    Index
    accountId builderCode? leverage? marketId price? side
    accountId: bigint

    Account whose collateral and positions constrain the result.

    builderCode?: PerpetualsBuilderCodeParamaters

    Optional integrator fee configuration for an order.

    If provided, the integrator specified in the configuration will receive a fee on the taker volume generated by this order. The integrator must have been previously approved by the account owner, and the fee must not exceed the maximum fee the user approved for that integrator.

    leverage?: number

    Optional leverage assumption used by the calculation.

    marketId: string

    Market in which the maximum order size is calculated.

    price?: number

    Optional order price assumption in quote units.

    side: PerpetualsOrderSide

    Side of the hypothetical order.

    Settings
    Member Visibility

    On This Page
    Properties