Skip to main content

Interface: BracketOrder

Charting Library.BracketOrder

Info about a placed order

Hierarchy​

Properties​

avgPrice​

• Optional avgPrice: number

Average fulfilled price for the order (double)

Inherited from​

BracketOrderBase.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​

BracketOrderBase.customFields

duration​

• Optional duration: OrderDuration

Order duration

Inherited from​

BracketOrderBase.duration

filledQty​

• Optional filledQty: number

Filled order quantity (double)

Inherited from​

BracketOrderBase.filledQty

id​

• id: string

Order ID

Inherited from​

BracketOrderBase.id

limitPrice​

• Optional limitPrice: number

Price for the limit order (double)

Inherited from​

BracketOrderBase.limitPrice

message​

• Optional message: OrderOrPositionMessage

Message describing the state of the order

Inherited from​

BracketOrderBase.message

parentId​

• parentId: string

If order is a bracket then this should contain base order/position id.

Inherited from​

BracketOrderBase.parentId

parentType​

• parentType: ParentType

Type of the bracket's parent

Inherited from​

BracketOrderBase.parentType

qty​

• qty: number

Order quantity (double)

Inherited from​

BracketOrderBase.qty

side​

• side: Side

Order side (buy or sell)

Inherited from​

BracketOrderBase.side

status​

• status: OrderStatus

Order status

Inherited from​

BracketOrderBase.status

stopLoss​

• Optional stopLoss: number

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

Inherited from​

BracketOrderBase.stopLoss

stopPrice​

• Optional stopPrice: number

Price for the stop order (double)

Inherited from​

BracketOrderBase.stopPrice

stopType​

• Optional stopType: StopType

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

Inherited from​

BracketOrderBase.stopType

symbol​

• symbol: string

Symbol name

Inherited from​

BracketOrderBase.symbol

takeProfit​

• Optional takeProfit: number

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

Inherited from​

BracketOrderBase.takeProfit

trailingStopPips​

• Optional trailingStopPips: number

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

Inherited from​

BracketOrderBase.trailingStopPips

type​

• type: OrderType

Order type

Inherited from​

BracketOrderBase.type

updateTime​

• Optional updateTime: number

Last update time (unix timestamp in milliseconds)

Inherited from​

BracketOrderBase.updateTime