Type Alias ApiPerpetualsCancelAndPlaceOrdersBody

Type Declaration

• OptionalbuilderCode?: PerpetualsBuilderCodeParamaters

  Optional integrator fee configuration.

• OptionalclientOrderIdsToCancel?: PerpetualsClientOrderId[]

  Optional client-managed order ids to cancel (in addition to orderIdsToCancel).

• OptionalexpiryTimestamp?: bigint

  Optional expiration timestamp in milliseconds since epoch.

• hasPosition: boolean

  Whether the account already has a position in this market.

• Optionalleverage?: number

  Optional leverage override.

• marketId: PerpetualsMarketId

  Market ID associated with the request.

• orderIdsToCancel: PerpetualsOrderId[]

  Order IDs to cancel.

• ordersToPlace: ApiPerpetualsOrderToPlace[]

  New orders to place after the cancellation.

• orderType: PerpetualsOrderType

  Order type (e.g. GTC, IOC).

• reduceOnly: boolean

  If true, placed orders can only reduce an existing position.

• OptionalshouldAbortOnMissingId?: boolean

  If true, abort the transaction when any ID in orderIdsToCancel is not found on-chain. If false (default), missing IDs are tolerated.

• OptionalshouldDeallocateFreeCollateral?: boolean

  If true, also deallocate free collateral (margin not backing a position) back to the wallet in the same transaction. Defaults to false.

• OptionaltxKind?: SerializedTransaction

  Optionally pre-built transaction payload.

• walletAddress: SuiAddress

  Wallet address used to identify the signer or owner.

• { accountCapId?: ObjectId; accountId: PerpetualsAccountId }

  • OptionalaccountCapId?: ObjectId

    Optional account capability object ID used to authorize the account operation.

  • accountId: PerpetualsAccountId

    Account ID associated with the request.

• { vaultId: ObjectId }

  • vaultId: ObjectId

    Vault object ID used instead of an account.