Order Entry API V2 - Get Order Status

1

header

2

→ applicationName

Application Name

String

Identifies the application generating the message.

3

→ applicationVendor

Application Vendor

String

Identifies the vendor of the application generating the message.

4

→ applicationVersion

Application Version

String

Identifies the version of the application generating the message.

5

→ requestId

Request ID

String

A unique identifier for the request provided by the client for correlation.

6

→ sentTime

Sent Time

DateTime

Timestamp of the message leaving the producing application.

7

payload

8

→ customerAccountIds

Customer Account IDs

String

• Length: ≤ 12

9

→ customerOrderId

Customer Order ID

String

• Length: ≤ 20

10

→ executingFirmIds[]

Executing Firm IDs

String

• Length: 1 - 10

11

→ glbxSecurityIds[]

Globex Security IDs

Integer

For future use only

12

→ manualInd

Manual Indicator

YesNoIndicator

• NO (No) - No

• YES (Yes) - Yes

Indicates whether the order was generated by automated trading logic.

13

→ operatorIds[]

Operator IDs

String

14

→ status

Status

OrderStatus

15

→ transactionTimeEnd

Transaction Time End

DateTime

16

→ transactionTimeStart

Transaction Time Start

DateTime

17

→ venueOrderIds[]

Venue Order IDs

String

1

header

2

→ requestId

Request ID

string

A unique identifier for the request provided by the client for correlation.

3

→ responseClippedInd

Response Clipped Indicator

yesNoIndicator

• NO (No) - No

• YES (Yes) - Yes

4

→ responseCount

Response Count

int32

5

→ sentTime

Sent Time

dateTime

Timestamp of the message leaving the producing application.

6

payload[]

7

→ action

Action

orderAction

• STATUS (Status)

8

→ cumulativeQtyInt

Cumulative Quantity Integer

int32

9

→ customerOrderId

Customer Order ID

string

10

→ displayQtyInt

Display Quantity Integer

int32

11

→ durationType

Duration Type

orderDurationType

• DAY (Day) - Order expires at the end of the trading day.

• FILL_AND_KILL (Fill and Kill) - Order is immediately executed against any available quantity and any remaining quantity is eliminated

• FILL_OR_KILL (Fill or Kill) - Order is filled completely or else eliminated

• GOOD_TILL_CANCEL (Good till Cancel) - Order remains working until cancelled

• GOOD_TILL_DATE (Good till Date) - Order remains working until the end of the trading session of the local market date specified in the ExpirationDate field.

12

→ entities

13

→ → customerAccountId

Customer Account ID

string

14

→ → executingFirmId

Executing Firm ID

string

15

→ → operatorId

Operator ID

string

16

→ → senderCountry

Sender Country

string

17

→ → senderState

Sender State

string

18

→ expirationDt

Expiration Date

date

Criteria

• ALWAYS when payload[].durationType = GOOD_TILL_DATE

19

→ instrument

20

→ → glbxGroupId

Globex Group ID

string

21

→ → glbxSecurityId

Globex Security ID

int32

22

→ manualInd

Manual Indicator

yesNoIndicator

• NO (No) - No

• YES (Yes) - Yes

Indicates whether the order was generated by automated trading logic.

23

→ marketSegmentId

Market Segment ID

int32

24

→ memo

Memo

string

25

→ minimumQtyInt

Minimum Quantity Integer

int32

26

→ price

Price

price

Criteria

• ALWAYS when payload[].type IN (LIMIT, STOP_LIMIT)

27

→ qtyInt

Quantity Integer

int32

28

→ rejectText

Reject Text

string

29

→ remainingQtyInt

Remaining Quantity Integer

int32

30

→ sideInd

Side Indicator

marketSideIndicator

• BUY (Buy) - Identifies a buy side order

• CROSS (Cross)

• SELL (Sell) - Identifies a sell side order

31

→ status

Status

orderStatus

32

→ stopPrice

Stop Price

price

Criteria

• ALWAYS when payload[].type IN (STOP, STOP_LIMIT)

33

→ transactionTime

Transaction Time

dateTime

34

→ type

Type

orderType

• LIMIT (Limit) - A Limit order defines the upper price limit at which to buy an instrument and lower price limit at which to sell an instrument. The price limit is defined in the Price field. If the price is not immediately available, the Limit order will rest until filled or cancelled.

• MARKET (Market) - A Market order with protection is filled within a pre-defined range of prices referred to as the protected range. For buy orders, protection points are added to the current best offer price to calculate the protection price limit. For sell orders, protection points are subtracted from the current best bid price.

• MARKET_TO_LIMIT (Market to Limit) - A Market-limit order is executed at the best price available in the market. If the market-limit order can only be partially filled, the order becomes a limit order and the remaining quantity remains on the order book at the specified limit price.

• STOP (Stop) - A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop order goes on the book as a Market order once triggered.

• STOP_LIMIT (Stop Limit) - A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop-Limit order goes on the book as a Limit order once triggered.

35

→ venueExecutionId

Venue Execution ID

string

36

→ venueOrderId

Venue Order ID

string

1

errors[]

2

→ code

Code

string

• 1 - {Unclassified error message}

• 100 - Request is invalid: {Error Message}

• 101 - {Field} is not present

• 102 - {Field} has an incorrect value: {Value}

• 103 - {Field} is invalid

3

→ message

Message

string

4

header

5

→ requestId

Request ID

string

A unique identifier for the request provided by the client for correlation.

6

→ sentTime

Sent Time

dateTime

Timestamp of the message leaving the producing application.

1

errors[]

2

→ code

Code

string

• 1 - {Unclassified error message}

• 100 - Request is invalid: {Error Message}

• 101 - {Field} is not present

• 102 - {Field} has an incorrect value: {Value}

• 103 - {Field} is invalid

3

→ message

Message

string

4

header

5

→ requestId

Request ID

string

A unique identifier for the request provided by the client for correlation.

6

→ sentTime

Sent Time

dateTime

Timestamp of the message leaving the producing application.

1

errors[]

2

→ code

Code

string

• 1 - {Unclassified error message}

• 100 - Request is invalid: {Error Message}

• 101 - {Field} is not present

• 102 - {Field} has an incorrect value: {Value}

• 103 - {Field} is invalid

3

→ message

Message

string

4

→ referenceField

Reference Field

string

5

header

6

→ requestId

Request ID

string

A unique identifier for the request provided by the client for correlation.

7

→ sentTime

Sent Time

dateTime

Timestamp of the message leaving the producing application.

8

payload[]

9

→ transactionTime

Transaction Time

dateTime