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

    Type Alias ApiPerpetualsPlaceSlTpOrdersBody

    ApiPerpetualsPlaceSlTpOrdersBody: {
        builderCode?: PerpetualsBuilderCodeParamaters;
        gasCoinArg?: TransactionObjectArgument;
        isSponsoredTx?: boolean;
        leverage?: number;
        limitOrderId?: PerpetualsOrderId;
        marketId: PerpetualsMarketId;
        positionSide: PerpetualsOrderSide;
        size?: bigint;
        sponsor?: PerpetualsSponsorConfig;
        stopLossPrice?: number;
        takeProfitPrice?: number;
        triggerPriceType?: PerpetualsStopOrderTriggerPriceType;
        txKind?: SerializedTransaction;
        walletAddress: SuiAddress;
    } & (
        | { accountCapId?: ObjectId; accountId: PerpetualsAccountId }
        | { vaultId: ObjectId }
    )

    API request body for placing SL/TP orders bound to a position.

    Type Declaration

    • OptionalbuilderCode?: PerpetualsBuilderCodeParamaters

      Optional integrator fee configuration applied when the SL/TP fires.

    • OptionalgasCoinArg?: TransactionObjectArgument

      Optional gas coin argument used when extending the transaction.

    • OptionalisSponsoredTx?: boolean

      Whether the transaction is sponsored rather than paid directly by the wallet.

    • Optionalleverage?: number

      Leverage applied by the request or preview.

    • OptionallimitOrderId?: PerpetualsOrderId

      Optional limit-order ID associated with the stop-loss or take-profit order.

    • marketId: PerpetualsMarketId

      Market ID associated with the request.

    • positionSide: PerpetualsOrderSide

      Position side to which the stop-loss or take-profit order applies.

    • Optionalsize?: bigint

      Order size in base units.

    • Optionalsponsor?: PerpetualsSponsorConfig

      Optional transaction sponsorship configuration.

    • OptionalstopLossPrice?: number

      Stop-loss trigger price.

    • OptionaltakeProfitPrice?: number

      Take-profit trigger price.

    • OptionaltriggerPriceType?: PerpetualsStopOrderTriggerPriceType

      Which on-chain price the trigger uses: 0 = index (default), 1 = book, 2 = mark.

    • OptionaltxKind?: SerializedTransaction

      Serialized transaction kind sent to the service.

    • walletAddress: SuiAddress

      Wallet address used to identify the signer or owner.