Order Entry V2 Websocket - Mass Order Cancel




Contents

Input - Mass Order Cancel


Submit mass order cancel request.


Fields

RefFieldNameData TypeValuesUsageDescription
1header
2→ applicationNameApplication NameString
REQUIRED

Identifies the application generating the message.

3→ applicationVendorApplication VendorString
REQUIRED

Identifies the vendor of the application generating the message.

4→ applicationVersionApplication VersionString
REQUIRED

Identifies the version of the application generating the message.

5→ messageTypeMessage TypeMessageType
  • ORDCXLM (Mass Order Cancel)
REQUIRED
6→ requestIdRequest IDString
REQUIRED

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

7→ sentTimeSent TimeDateTime
REQUIRED

Timestamp of the message leaving the producing application.

8payload
9→ customerAccountIdCustomer Account IDString
  • Length: 1 - 12
REQUIRED
10→ durationTypeDuration TypeOrderDurationType
  • DAY (Day) - Order expires at the end of the trading day.
  • 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.
OPTIONAL
11→ entityScopeEntity ScopeOrderEntityScope
  • CUSTOMER_ACCOUNT (Customer Account)
  • OPERATOR (Operator)
OPTIONAL
12→ executingFirmIdExecuting Firm IDString
  • Length: 1 - 10
REQUIRED
13→ glbxGroupIdGlobex Group IDString
CONDITIONAL

Support for single Globex Group ID is offered today

Criteria
  • ALWAYS when payload.instrumentScope = PRODUCT_GROUP
14→ glbxSecurityIdGlobex Security IDInteger
CONDITIONAL
Criteria
  • ALWAYS when payload.instrumentScope = INSTRUMENT
15→ instrumentScopeInstrument ScopeOrderInstrumentScope
  • ALL (All)
  • INSTRUMENT (Instrument)
  • MARKET_SEGMENT (Market Segment)
  • PRODUCT_GROUP (Product Group)
REQUIRED
16→ manualIndManual IndicatorYesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
REQUIRED

Indicates whether the order was generated by automated trading logic.

17→ marketSegmentIdMarket Segment IDInteger
CONDITIONAL
Criteria
  • ALWAYS when payload.instrumentScope = MARKET_SEGMENT
18→ operatorIdOperator IDString
  • Length: 1 - 18
REQUIRED
19→ senderCountrySender CountryString
  • Length: 1 - 2
REQUIRED
20→ senderStateSender StateString
  • Length: 2 - 2
OPTIONAL
21→ sideIndSide IndicatorMarketSideIndicator
  • BUY (Buy) - Identifies a buy side order
  • CROSS (Cross)
  • SELL (Sell) - Identifies a sell side order
OPTIONAL
22→ typeTypeOrderType
  • 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.
  • 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.
OPTIONAL

Output - Mass Order Cancel Response - Success

Fields

RefFieldNameData TypeValuesUsageDescription
1header
2→ messageTypeMessage TypemessageType
  • ORDSTS (Order Status)
ALWAYS
3→ possibleRetransIndPossible Retransmission IndicatoryesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
OPTIONAL
4→ reportIdReport IDstring
ALWAYS
5→ requestIdRequest IDstring
ALWAYS

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

6→ responseCountResponse Countint32
ALWAYS
7→ responseLastFragmentIndResponse Last Fragment IndicatoryesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
OPTIONAL
8→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

9→ sequenceNbrSequence Numberstring
ALWAYS
10payload
11→ actionActionorderAction
  • CANCEL_MASS (Mass Cancel)
ALWAYS
12→ durationTypeDuration TypeorderDurationType
  • 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.
OPTIONAL
13→ manualIndManual IndicatoryesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
ALWAYS

Indicates whether the order was generated by automated trading logic.

14→ marketSegmentIdMarket Segment IDint32
ALWAYS
15→ orderKeys[]
16→ → canceledQtyIntCanceled Quantity Intint32
ALWAYS
17→ → customerOrderIdCustomer Order IDstring
ALWAYS
18→ → venueOrderIdVenue Order IDstring
ALWAYS
19→ senderCountrySender Countrystring
ALWAYS
20→ senderStateSender Statestring
OPTIONAL
21→ sideIndSide IndicatormarketSideIndicator
  • BUY (Buy) - Identifies a buy side order
  • CROSS (Cross)
  • SELL (Sell) - Identifies a sell side order
OPTIONAL
22→ transactionTimeTransaction TimedateTime
ALWAYS
23→ typeTypeorderType
  • 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.
OPTIONAL

Output - Mass Order Cancel Response - Error

Fields

RefFieldNameData TypeValuesUsageDescription
1errors[]
2→ codeCodestring
ALWAYS
3→ messageMessagestring
ALWAYS
4→ referenceFieldReference Fieldstring
OPTIONAL
5header
6→ messageTypeMessage TypemessageType
  • ORDCXLMRJ (Mass Order Cancel Reject)
ALWAYS
7→ requestIdRequest IDstring
ALWAYS

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

8→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

9→ sequenceNbrSequence Numberstring
ALWAYS
10payload
11→ transactionTimeTransaction TimedateTime
OPTIONAL



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.