Page Comparison

Excerpt

hidden	false

Get order status for single (or multiple) working order(s)

Style
.wiki-content .columnLayout .cell.aside {width:400px;}

Panel

borderColor	lightgray

Page Properties

URL	/order/status
HTTP Method	POST
Version	2.0.0

Panel

borderColor	lightgray
titleBGColor	whitesmoke
title	Contents

Table of Contents

maxLevel	3

Request

Body

Ref Field Name Data Type Values Usage Description

1 header

2

→ applicationName

Application Name

String

REQUIRED

Identifies the application generating the message.

3

→ applicationVendor

Application Vendor

String

REQUIRED

Identifies the vendor of the application generating the message.

4

→ applicationVersion

Application Version

String

REQUIRED

Identifies the version of the application generating the message.

5

→ requestId

Request ID

String

REQUIRED

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

6

→ sentTime

Sent Time

DateTime

REQUIRED

Timestamp of the message leaving the producing application.

7 payload

8

→ customerAccountIds

Customer Account IDs

String

Length: ≤ 12

OPTIONAL

9

→ customerOrderId

Customer Order ID

String

Length: ≤ 20

OPTIONAL

10

→ executingFirmIds[]

Executing Firm IDs

String

Length: 1 - 10

REQUIRED

11

→ glbxSecurityIds[]

Globex Security IDs

Integer

OPTIONAL

For future use only

12

→ manualInd

Manual Indicator

YesNoIndicator

NO NO (No) - No
YES YES (Yes) - Yes

REQUIRED

Indicates whether the order was generated by automated trading logic.

13 → operatorIds[] Operator IDs String OPTIONAL

14

→ status

Status

OrderStatus

Expand
`CANCELED` CANCELED (Canceled) `EXPIRED` EXPIRED (Expired) `FILLED` FILLED (Filled) `NEW` NEW (New) `PARTIAL` PARTIAL (Partial) `REJECTED` REJECTED (Rejected) `REPLACED` REPLACED (Replaced)

OPTIONAL

15 → transactionTimeEnd Transaction Time End DateTime OPTIONAL

16 → transactionTimeStart Transaction Time Start DateTime OPTIONAL

17 → venueOrderIds[] Venue Order IDs String OPTIONAL

Response - 200

Body

DAY KILL KILL CANCEL DATE

Ref Field Name Data Type Values Usage Description

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) - No
YES 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 (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 payloadwhen 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) - No
YES 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 payloadwhen payload[].type IN (LIMIT, STOP_LIMIT)

27 → qtyInt Quantity Integer int32 ALWAYS

28 → rejectText Reject Text string OPTIONAL

29 → remainingQtyInt Remaining Quantity Integer int32 ALWAYS

30

→ sideInd

Side Indicator

marketSideIndicator

BUY BUY (Buy) - Identifies a buy side order
CROSS CROSS (Cross)
SELL SELL (Sell) - Identifies a sell side order

ALWAYS

31

→ status

Status

orderStatus

Expand
`CANCELED` CANCELED (Canceled) `EXPIRED` EXPIRED (Expired) `FILLED` FILLED (Filled) `NEW` NEW (New) `PARTIAL` PARTIAL (Partial) `REJECTED` REJECTED (Rejected) `REPLACED` REPLACED (Replaced)

ALWAYS

32

→ stopPrice

Stop Price

price

CONDITIONAL

Criteria

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

33 → transactionTime Transaction Time dateTime ALWAYS

34

→ type

Type

orderType

LIMIT 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 (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 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 (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 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.

ALWAYS

35 → venueExecutionId Venue Execution ID string ALWAYS

36 → venueOrderId Venue Order ID string ALWAYS

Response - 400

Body

Ref	Field	Name	Data Type	Values	Usage	Description
1	errors[]
2	→ code	Code	string	`1` 1 - {Unclassified error message} `100` 100 - Request is invalid: {Error Message} `101` 101 - {Field} is not present `102` 102 - {Field} has an incorrect value: {Value} `103` 103 - {Field} is invalid	ALWAYS
3	→ message	Message	string		ALWAYS
4	header
5	→ requestId	Request ID	string		ALWAYS	A unique identifier for the request provided by the client for correlation.
6	→ sentTime	Sent Time	dateTime		ALWAYS	Timestamp of the message leaving the producing application.

Response - 403

Body

Ref	Field	Name	Data Type	Values	Usage	Description
1	errors[]
2	→ code	Code	string	`1` 1 - {Unclassified error message} `100` 100 - Request is invalid: {Error Message} `101` 101 - {Field} is not present `102` 102 - {Field} has an incorrect value: {Value} `103` 103 - {Field} is invalid	ALWAYS
3	→ message	Message	string		ALWAYS
4	header
5	→ requestId	Request ID	string		ALWAYS	A unique identifier for the request provided by the client for correlation.
6	→ sentTime	Sent Time	dateTime		ALWAYS	Timestamp of the message leaving the producing application.

Response - 500

Body

Ref	Field	Name	Data Type	Values	Usage	Description
1	errors[]
2	→ code	Code	string	`1` 1 - {Unclassified error message} `100` 100 - Request is invalid: {Error Message} `101` 101 - {Field} is not present `102` 102 - {Field} has an incorrect value: {Value} `103` 103 - {Field} is invalid	ALWAYS
3	→ message	Message	string		ALWAYS
4	→ referenceField	Reference Field	string		OPTIONAL
5	header
6	→ requestId	Request ID	string		ALWAYS	A unique identifier for the request provided by the client for correlation.
7	→ sentTime	Sent Time	dateTime		ALWAYS	Timestamp of the message leaving the producing application.
8	payload[]
9	→ transactionTime	Transaction Time	dateTime		OPTIONAL

Version	Old Version 1	New Version Current
Changes made by	Space Sync for Confluence	Space Sync for Confluence
Saved on	Dec 21, 2024	Dec 30, 2024

Versions Compared

Key

Request

Body

Response - 200

Body

Criteria

Criteria

Criteria

Response - 400

Body

Response - 403

Body

Response - 500

Body