ApiOrderDTO

Description

Represents an order.

Properties

Name

Type

Description

OrderId

integer

The order identifier.

Reference

string

Reference identifier for the instruction.

OrderReference

string

Reference identifier for the order.

AutoRollover

boolean

Flag to indicate whether the trade will automatically roll into the next contract when the current contract expires. Only applies to markets where the underlying is a futures contract.

MarketId

integer

A market's unique identifier.

Direction

string

Direction identifier for trade, values supported are Buy or Sell.

Quantity

number

format

decimal

The current size of the order.

OriginalQuantity

number

format

decimal

The original size of the order before user modification.

Price

number

nullable	true
format	decimal

The currently set price at which the order is triggered.

OriginalPrice

number

nullable	true
format	decimal

The original price to trigger the order before user modification.

TradingAccountId

integer

The ID of the Trading Account associated with the order.

CurrencyId

integer

Currency ID for order (as represented in the trading system).

StatusId

integer

Status ID of order (as represented in the trading system). The table of lookup codes can be found at Lookup Values.

TypeId

integer

The type of the order: trade, stop or limit. The table of lookup codes can be found at Lookup Values.

IfDone

ApiIfDoneDTO

List of If/Done Orders which will be filled when the initial order is triggered.

OcoOrder

ApiStopLimitOrderDTO

Corresponding OCO Order (One Cancels the Other).

LastChangedDateTimeUTC

string

nullable	true
format	wcf-date

The date and time when the order was last changed, or executed.

AssociatedOrders

ApiAssociatedDTO

Any associated orders linked to this one. An associated order is linked to a net position rather than to specific individual trades.

Last updated: 23 June 2022