Type Alias ApiPerpetualsScaleOrderBody

Type Declaration

• OptionalbuilderCode?: PerpetualsBuilderCodeParamaters

  Optional integrator fee configuration.

• cancelSlTp: boolean

  True if position is closed.

• OptionalclientOrderIds?: PerpetualsClientOrderId[]

  Optional client-managed order ids to tag the scale ladder with. When provided, the length should match numberOfOrders; the id at each index tags the corresponding ladder order.

• collateralChange: number

  Collateral change associated with this order.

• endPrice: bigint

  Ending price of the scale range (inclusive, scaled bigint).

• 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.

• numberOfOrders: number

  Number of limit orders to place across the range.

• orderType: PerpetualsOrderType

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

• reduceOnly: boolean

  If true, orders can only reduce an existing position.

• side: PerpetualsOrderSide

  Order side: 0 for bid or long, 1 for ask or short.

• OptionalsizeSkew?: number

  Size ratio between last and first order. 1.0 = uniform, 2.0 = last is 2x first.

• Optionalsponsor?: PerpetualsSponsorConfig

  Optional transaction sponsorship configuration.

• startPrice: bigint

  Starting price of the scale range (inclusive, scaled bigint).

• totalSize: bigint

  Total size distributed across all orders (base asset amount, scaled bigint).

• 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.