Class TrailingStopOrder

Represents a trailing-stop order.

Hierarchy

  • TrailingStopOrder

Constructors

constructor

Properties

action auxPrice? orderType parentId? tif? totalQuantity trailingPercent? transmit?

Constructors

constructor

  • Create a trailing-stop order.

    Parameters

    • action: OrderAction

      The order action (buy or sell)

    • totalQuantity: number

      The number of positions being bought/sold.

    • Optional auxPrice: number

      Generic field to contain the stop price for STP LMT orders, trailing amount, etc.

    • Optional trailingPercent: number

      Specifies the trailing amount of a trailing stop order as a percentage. This field is mutually exclusive with the existing trailing amount. That is, the API client can send one or the other but not both. This field is read AFTER the stop price (barrier price) as follows: deltaNeutralAuxPrice stopPrice, trailingPercent, scale order attributes. The field will also be sent to the API in the openOrder message if the API client version is >= 56. It is sent after the stopPrice field as follows: stopPrice, trailingPct, basisPoint

    • Optional transmit: boolean

      Specifies whether the order will be transmitted by TWS. If set to false`, the order will be created at TWS but will not be sent.

    • Optional parentId: number

      The order ID of the parent order, used for bracket and auto trailing stop orders..

    • Optional tif: TimeInForce

      The time in force. Valid values are:

      • DAY - Valid for the day only.
      • GTC - Good until canceled.

    Returns TrailingStopOrder

Properties

action

action: OrderAction

The order action (buy or sell)

Optional auxPrice

auxPrice?: number

Generic field to contain the stop price for STP LMT orders, trailing amount, etc.

Readonly orderType

orderType: TRAIL = OrderType.TRAIL

The order's type (must be [[OrderType.TRAIL]]).

Optional parentId

parentId?: number

The order ID of the parent order, used for bracket and auto trailing stop orders..

Optional tif

tif?: TimeInForce

The time in force. Valid values are:

  • DAY - Valid for the day only.
  • GTC - Good until canceled.

totalQuantity

totalQuantity: number

The number of positions being bought/sold.

Optional trailingPercent

trailingPercent?: number

Specifies the trailing amount of a trailing stop order as a percentage. This field is mutually exclusive with the existing trailing amount. That is, the API client can send one or the other but not both. This field is read AFTER the stop price (barrier price) as follows: deltaNeutralAuxPrice stopPrice, trailingPercent, scale order attributes. The field will also be sent to the API in the openOrder message if the API client version is >= 56. It is sent after the stopPrice field as follows: stopPrice, trailingPct, basisPoint

Optional transmit

transmit?: boolean

Specifies whether the order will be transmitted by TWS. If set to false`, the order will be created at TWS but will not be sent.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc