Interface: BracketOrder

Broker.BracketOrder

An object that contains information about a bracket order.

Hierarchy

• PlacedOrder

  ↳ BracketOrder

Properties

avgPrice

Optional

avgPrice: number

Average fulfilled price for the order (double)

Inherited from

PlacedOrder.avgPrice

---

customFields

Optional

customFields: CustomInputFieldsValues

An object that contains the results of broker specific user inputs (for example a digital signature). There are two possible kinds of custom fields: an input field with a checkbox and a custom combobox.

Inherited from

PlacedOrder.customFields

---

duration

Optional

duration: OrderDuration

Order duration

Inherited from

PlacedOrder.duration

---

exitLevelId

Optional

exitLevelId: string

Exit level ID. The way we distinguish exit levels

---

exitLevels

Optional

exitLevels: ExitLevel[]

Exit levels associated with the placed order. Used when BrokerConfigFlags.supportMultipleExitLevels is enabled.

Inherited from

PlacedOrder.exitLevels

---

extra

Optional

extra: ExtraData

Inherited from

PlacedOrder.extra

---

filledQty

Optional

filledQty: number

Filled order quantity (double)

Inherited from

PlacedOrder.filledQty

---

guaranteedStop

Optional

guaranteedStop: number

Guaranteed stop loss price (double). Available when Brackets are enabled and supportGuaranteedStop flag is set to true

Inherited from

PlacedOrder.guaranteedStop

---

id

id: string

Order ID

Inherited from

PlacedOrder.id

---

limitPrice

Optional

limitPrice: number

Price for the limit order (double)

Inherited from

PlacedOrder.limitPrice

---

message

Optional

message: OrderOrPositionMessage

Message describing the state of the order

Inherited from

PlacedOrder.message

---

parentId

parentId: string

If an order is a bracket, it should contain an ID of a parent order/position.

---

parentType

parentType: ParentType

Type of the bracket's parent.

---

qty

qty: number

Order quantity (double)

Inherited from

PlacedOrder.qty

---

side

side: Side

Order side (buy or sell)

Inherited from

PlacedOrder.side

---

status

status: OrderStatus

Order status

Inherited from

PlacedOrder.status

---

stopLoss

Optional

stopLoss: number

Stop loss price (double). Available when Brackets are enabled

Inherited from

PlacedOrder.stopLoss

---

stopPrice

Optional

stopPrice: number

Price for the stop order (double)

Inherited from

PlacedOrder.stopPrice

---

stopType

Optional

stopType: StopType

Stop Loss type. It should be set to 1 (StopType.TrailingStop) for trailing stop orders.

Inherited from

PlacedOrder.stopType

---

symbol

symbol: string

Symbol name

Inherited from

PlacedOrder.symbol

---

takeProfit

Optional

takeProfit: number

Take profit price (double). Available when Brackets are enabled

Inherited from

PlacedOrder.takeProfit

---

trailingStopPips

Optional

trailingStopPips: number

Trailing stop Pips value (double). Available when Brackets are enabled

Inherited from

PlacedOrder.trailingStopPips

---

trailingStopPrice

Optional

trailingStopPrice: number

Trailing stop price (double). Available when Brackets are enabled

Inherited from

PlacedOrder.trailingStopPrice

---

type

type: OrderType

Order type

Inherited from

PlacedOrder.type

---

updateTime

Optional

updateTime: number

Last update time (unix timestamp in milliseconds)

Inherited from

PlacedOrder.updateTime