Skip to main content
Version: latest

BracketOrder

Interface
Types Module: Broker

An object that contains information about a bracket order.

Properties​

avgPrice​

Optional

Average fulfilled price for the order (double)

Type​

​number

customFields​

Optional

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.

Type​

​CustomInputFieldsValues

duration​

Optional

Order duration

Type​

​OrderDuration

filledQty​

Optional

Filled order quantity (double)

Type​

​number

guaranteedStop​

Optional

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

Type​

​number

id​

Order ID

Type​

​string

limitPrice​

Optional

Price for the limit order (double)

Type​

​number

message​

Optional

Message describing the state of the order

Type​

​OrderOrPositionMessage

parentId​

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

Type​

​string

parentType​

Type of the bracket's parent.

Type​

​ParentType

qty​

Order quantity (double)

Type​

​number

side​

Order side (buy or sell)

Type​

​Side

status​

Order status

Type​

​OrderStatus

stopLoss​

Optional

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

Type​

​number

stopPrice​

Optional

Price for the stop order (double)

Type​

​number

stopType​

Optional

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

Type​

​StopType

symbol​

Symbol name

Type​

​string

takeProfit​

Optional

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

Type​

​number

trailingStopPips​

Optional

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

Type​

​number

type​

Order type

Type​

​OrderType

updateTime​

Optional

Last update time (unix timestamp in milliseconds)

Type​

​number