Type Alias ApiPerpetualsPreviewPlaceOrderResponse

Type Declaration

• { error: string }

  • error: string

    Error message returned when the operation cannot be completed.

• {
      cancelSlTp: boolean;
      collateralChange: number;
      executionPrice: number;
      filledSize: number;
      filledSizeUsd: number;
      hasPosition: boolean;
      percentSlippage: number;
      postedSize: number;
      postedSizeUsd: number;
      priceSlippage: number;
      updatedPosition: PerpetualsPosition;
  }

  • cancelSlTp: boolean

    True is position is closed.

  • collateralChange: number

    Net collateral change in USD (e.g. fees, margin changes).

  • executionPrice: number

    Effective execution price for the filled portion of the order.

  • filledSize: number

    Size that is expected to be filled immediately (in base units).

  • filledSizeUsd: number

    Notional value in USD of the filledSize.

  • hasPosition: boolean

    Whether there is an existing position in this market.

  • percentSlippage: number

    Relative price slippage expressed as a fraction (e.g. 0.01 == 1% slippage).

  • postedSize: number

    Any size that remains posted as liquidity (for market orders this is usually zero unless partially resting is supported).

  • postedSizeUsd: number

    Notional value in USD of the postedSize. For pure market orders this is typically 0.

  • priceSlippage: number

    Absolute price slippage between reference price and execution price.

  • updatedPosition: PerpetualsPosition

    Simulated position after the market order.