Order Entry API V2 - Cancel Order

Cancel a working order by the Venue Order ID and/or Customer Order ID
URL/order/cancel
HTTP MethodPUT
Version2.0.0
Contents

Request

Body

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→ requestIdRequest IDString
REQUIRED

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

6→ sentTimeSent TimeDateTime
REQUIRED

Timestamp of the message leaving the producing application.

7payload
8→ customerOrderIdCustomer Order IDString
  • Length: 1 - 20
REQUIRED
9→ entities
10→ → customerAccountIdCustomer Account IDString
  • Length: 1 - 12
REQUIRED
11→ → customerOriginTypeCustomer Origin TypeOriginType
  • CUSTOMER (Customer)
  • HOUSE (House)
REQUIRED
12→ → customerTypeCustomer TypeCustomerType
  • MEMBER_OWN (Member Own) - Applies to orders entered or trades executed by an individual member for their own account, for an account they controls, or for an account in which they have an ownership or financial interest. However, transactions initiated and executed by a member for the proprietary account of a member firm must be designated as Member Other Member transactions.
  • MEMBER_PROPRIETARY (Member Proprietary) - Applies to orders entered or trades executed for the proprietary accounts of a member firm, including Rule 106.H., I., N., R. and S. firms.
  • ON_BEHALF_INDIVIDUAL (On-Behalf Individual) - Applies to orders entered by a member or a nonmember terminal operator for the account of another individual member or an account controlled by such individual member.
  • OTHER (Other) - Applies to all orders and transactions not included in any of the defined categories. These typically are orders entered by or on behalf of nonmember entities.
REQUIRED
13→ → executingFirmIdExecuting Firm IDString
  • Length: 1 - 10
REQUIRED
14→ → operatorIdOperator IDString
  • Length: 1 - 18
REQUIRED
15→ → senderCountrySender CountryString
  • Length: 1 - 2
REQUIRED
16→ → senderStateSender StateString
  • Length: 2 - 2
OPTIONAL
17→ instrument
18→ → glbxSecurityIdGlobex Security IDInteger
REQUIRED
19→ manualIndManual IndicatorYesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
REQUIRED

Indicates whether the order was generated by automated trading logic.

20→ sideIndSide IndicatorMarketSideIndicator
  • BUY (Buy) - Identifies a buy side order
  • CROSS (Cross)
  • SELL (Sell) - Identifies a sell side order
REQUIRED
21→ venueOrderIdVenue Order IDString
OPTIONAL

Response - 200

Body

RefFieldNameData TypeValuesUsageDescription
1header
2→ requestIdRequest IDstring
ALWAYS

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

3→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

4payload
5→ actionActionorderAction
  • CANCEL (Cancel)
ALWAYS
6→ cancelReasonCancel ReasonorderCancelReason
 Click here to expand...
  • AGGRESSIVE_SELF_MATCH (Aggressive Self-Match)
  • CREDIT_CONTROL (Credit Control)
  • DISCONNECT (Disconnect)
  • EXCHANGE (Exchange)
  • MINIMUM_QUANTITY (Minimum Quantity)
  • NOT_BEST (Not Best)
  • RESTING_SELF_MATCH (Resting Self-Match)
  • RISK_MANAGEMENT (Risk Management)
OPTIONAL
7→ cumulativeQtyIntCumulative Quantity Integerint32
ALWAYS
8→ customerOrderIdCustomer Order IDstring
ALWAYS
9→ displayQtyIntDisplay Quantity Integerint32
OPTIONAL
10→ 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.
ALWAYS
11→ entities
12→ → customerAccountIdCustomer Account IDstring
ALWAYS
13→ → customerOriginTypeCustomer Origin TypeoriginType
  • CUSTOMER (Customer)
  • HOUSE (House)
ALWAYS
14→ → customerTypeCustomer TypecustomerType
  • MEMBER_OWN (Member Own) - Applies to orders entered or trades executed by an individual member for their own account, for an account they controls, or for an account in which they have an ownership or financial interest. However, transactions initiated and executed by a member for the proprietary account of a member firm must be designated as Member Other Member transactions.
  • MEMBER_PROPRIETARY (Member Proprietary) - Applies to orders entered or trades executed for the proprietary accounts of a member firm, including Rule 106.H., I., N., R. and S. firms.
  • ON_BEHALF_INDIVIDUAL (On-Behalf Individual) - Applies to orders entered by a member or a nonmember terminal operator for the account of another individual member or an account controlled by such individual member.
  • OTHER (Other) - Applies to all orders and transactions not included in any of the defined categories. These typically are orders entered by or on behalf of nonmember entities.
ALWAYS
15→ → executingFirmIdExecuting Firm IDstring
ALWAYS
16→ → senderCountrySender Countrystring
ALWAYS
17→ → senderStateSender Statestring
OPTIONAL
18→ expirationDtExpiration Datedate
CONDITIONAL
Criteria
  • ALWAYS when payload.durationType = GOOD_TILL_DATE
19→ instrument
20→ → glbxSecurityIdGlobex Security IDint32
ALWAYS
21→ manualIndManual IndicatoryesNoIndicator
  • NO (No) - No
  • YES (Yes) - Yes
ALWAYS

Indicates whether the order was generated by automated trading logic.

22→ minimumQtyIntMinimum Quantity Integerint32
OPTIONAL
23→ pricePriceprice
CONDITIONAL
Criteria
  • ALWAYS when payload.type IN (LIMIT, STOP_LIMIT)
24→ qtyIntQuantity Integerint32
ALWAYS
25→ sideIndSide IndicatormarketSideIndicator
  • BUY (Buy) - Identifies a buy side order
  • CROSS (Cross)
  • SELL (Sell) - Identifies a sell side order
ALWAYS
26→ statusStatusorderStatus
  • CANCELED (Canceled)
  • UNDEFINED (Undefined)
ALWAYS
27→ stopPriceStop Priceprice
CONDITIONAL
Criteria
  • ALWAYS when payload.type IN (STOP, STOP_LIMIT)
28→ transactionTimeTransaction TimedateTime
ALWAYS
29→ 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.
ALWAYS
30→ venueExecutionIdVenue Execution IDstring
ALWAYS
31→ venueOrderIdVenue Order IDstring
ALWAYS

Response - 400

Body

RefFieldNameData TypeValuesUsageDescription
1errors[]
2→ codeCodestring
  • 1 - {Unclassified error message}
ALWAYS
3→ messageMessagestring
ALWAYS
4header
5→ requestIdRequest IDstring
ALWAYS

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

6→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

Response - 403

Body

RefFieldNameData TypeValuesUsageDescription
1errors[]
2→ codeCodestring
  • 1 - {Unclassified error message}
ALWAYS
3→ messageMessagestring
ALWAYS
4header
5→ requestIdRequest IDstring
ALWAYS

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

6→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

Response - 500

Body

RefFieldNameData TypeValuesUsageDescription
1errors[]
2→ codeCodestring
 Click here to expand...
  • 1 - {Unclassified error message}
  • 100 - Request is invalid: {Error Message}
  • 1003 - Orders may not be entered while the market is closed Orders may not be entered while the market is paused Orders may not be canceled while the market is closed Orders may not be canceled while the market is paused
  • 101 - {Field} is not present
  • 102 - {Field} has an incorrect value: {Value}
  • 103 - {Field} is invalid
  • 2048 - The order was submitted with a different SenderCompID than the requesting cancel
  • 2051 - The Order was submitted with a different side than the requesting Cancel
  • 7024 - Order cannot be modified or cancelled while the market is in No Cancel
  • 7027 - Order type not permitted while the market is reserved
  • 7029 - Orders may not be entered while the market is forbidden
ALWAYS
3→ messageMessagestring
ALWAYS
4→ referenceFieldReference Fieldstring
OPTIONAL
5header
6→ requestIdRequest IDstring
ALWAYS

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

7→ sentTimeSent TimedateTime
ALWAYS

Timestamp of the message leaving the producing application.

8payload
9→ customerOrderIdCustomer Order IDstring
ALWAYS
10→ transactionTimeTransaction TimedateTime
OPTIONAL
11→ venueOrderIdVenue Order IDstring
OPTIONAL



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.