Type Alias ApiPerpetualsPreviewPlaceLimitOrderBody

ApiPerpetualsPreviewPlaceLimitOrderBody: Omit<
    ApiPerpetualsLimitOrderBody,
    | "collateralChange"
    | "walletAddress"
    | "hasPosition"
    | "cancelSlTp"
    | "txKind"
    | "accountId"
    | "slTp",
> & { leverage?: number; shouldDeallocateFreeCollateral?: boolean } & (
    | { accountId: PerpetualsAccountId
    | undefined }
    | { vaultId: ObjectId | undefined }
)

Request body for previewing a limit order placement (before sending a tx).

This version is used by the API and includes account or vault context.

Type Declaration

Optionalleverage?: number

Optional leverage override for the preview.
OptionalshouldDeallocateFreeCollateral?: boolean

If true, the preview includes deallocating free collateral (margin not backing a position) back to the wallet. Defaults to false.

{ accountId: PerpetualsAccountId | undefined }
- accountId: PerpetualsAccountId | undefined
  
  Account ID associated with the request.
{ vaultId: ObjectId | undefined }
- vaultId: ObjectId | undefined
  
  Vault object ID used instead of an account.

Type Alias ApiPerpetualsPreviewPlaceLimitOrderBody

Type Declaration

`Optional`leverage?: number

`Optional`shouldDeallocateFreeCollateral?: boolean

accountId: PerpetualsAccountId | undefined

vaultId: ObjectId | undefined

Settings

Type Alias ApiPerpetualsPreviewPlaceLimitOrderBody

Type Declaration

Optionalleverage?: number

OptionalshouldDeallocateFreeCollateral?: boolean

accountId: PerpetualsAccountId | undefined

vaultId: ObjectId | undefined

Settings

`Optional`leverage?: number

`Optional`shouldDeallocateFreeCollateral?: boolean