Skip to main content

Interface: PlacedOrderBase

Broker.PlacedOrderBase

An object that contains information about a placed order.

Hierarchy​

Properties​

avgPrice​

• Optional avgPrice: number

Average fulfilled price for the order (double)

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.

duration​

• Optional duration: OrderDuration

Order duration

filledQty​

• Optional filledQty: number

Filled order quantity (double)

id​

• id: string

Order ID

limitPrice​

• Optional limitPrice: number

Price for the limit order (double)

message​

• Optional message: OrderOrPositionMessage

Message describing the state of the order

qty​

• qty: number

Order quantity (double)

side​

• side: Side

Order side (buy or sell)

status​

• status: OrderStatus

Order status

stopLoss​

• Optional stopLoss: number

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

stopPrice​

• Optional stopPrice: number

Price for the stop order (double)

stopType​

• Optional stopType: StopType

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

symbol​

• symbol: string

Symbol name

takeProfit​

• Optional takeProfit: number

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

trailingStopPips​

• Optional trailingStopPips: number

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

type​

• type: OrderType

Order type

updateTime​

• Optional updateTime: number

Last update time (unix timestamp in milliseconds)