Order Entry API V2 - Get Order Status

/order/status

POST

2.0.0

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

ALWAYS

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

3

→ responseClippedInd

Response Clipped Indicator

yesNoIndicator

• NO (No) - No

• YES (Yes) - Yes

OPTIONAL

4

→ responseCount

Response Count

int32

OPTIONAL

5

→ sentTime

Sent Time

dateTime

ALWAYS

Timestamp of the message leaving the producing application.

6

payload[]

7

→ action

Action

orderAction

• STATUS (Status)

ALWAYS

8

→ cumulativeQtyInt

Cumulative Quantity Integer

int32

ALWAYS

9

→ customerOrderId

Customer Order ID

string

ALWAYS

10

→ displayQtyInt

Display Quantity Integer

int32

OPTIONAL

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.

ALWAYS

12

→ entities

13

→ → customerAccountId

Customer Account ID

string

ALWAYS

14

→ → executingFirmId

Executing Firm ID

string

ALWAYS

15

→ → operatorId

Operator ID

string

ALWAYS

16

→ → senderCountry

Sender Country

string

ALWAYS

17

→ → senderState

Sender State

string

OPTIONAL

18

→ expirationDt

Expiration Date

date

CONDITIONAL

Criteria

• ALWAYS when payload[].durationType = GOOD_TILL_DATE

19

→ instrument

20

→ → glbxGroupId

Globex Group ID

string

ALWAYS

21

→ → glbxSecurityId

Globex Security ID

int32

ALWAYS

22

→ manualInd

Manual Indicator

yesNoIndicator

• NO (No) - No

• YES (Yes) - Yes

ALWAYS

Indicates whether the order was generated by automated trading logic.

23

→ marketSegmentId

Market Segment ID

int32

ALWAYS

24

→ memo

Memo

string

OPTIONAL

25

→ minimumQtyInt

Minimum Quantity Integer

int32

OPTIONAL

26

→ price

Price

price

CONDITIONAL

Criteria

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

27

→ qtyInt

Quantity Integer

int32

ALWAYS

28

→ rejectText

Reject Text

string