- Created by Confluence Admin, last modified on Mar 30, 2021
This topic contains a table with filters to query iLink message specification tags.
This page lists all iLink message types in a set order. Message types may be blank if the filter is not applicable.
Please scroll through the list of messages to see full results.
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
-
Page:iLink 3 Order Cancel Replace Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
638 PriorityIndicator - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority. 44 Price PRICENULL9 8 N Price per share or contract. Conditionally required if the order type requires a price (not market orders). 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
- Cancel Replace Request submitted with quantity greater than 99999 will be rejected with a Business Level Reject (35=j) message.
- Cancel Replace Request submitted with quantity greater than the Max Quantity and less than 99999 will be rejected with an Execution Report - Reject (35=8) message.
Maximum Quantity is defined in the market data Security Definition(35=d) message in tag 1140-MaxTradeVol.- Note - the CME Globex maximum quantity limit per instrument also serves as an effective constraint on the maximum order value as required by MiFID II.
For EBS, this is the notional value instead of the lot size.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64NULL 8 N Globally unique identifier for each order assigned by the exchange.
Required for BrokerTec.
Optional for F&O and EBS.
99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (conditionally required if tag 40-OrdType = 3 or 4). 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
For EBS, this is the notional value instead of the lot size.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for Display Quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
For EBS, this is the notional value instead of the lot size.
432 ExpireDate LocalMktDate 2 N Date of order expiration (last day the order can trade), always expressed in terms of the local market date. Applicable only to GTD orders, which expire at the end of the trading session specified. This value must be a future or current session date and cannot be in the past. 40 OrdType OrderTypeReq 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=3 (Stop order with protection)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect.
FOK is supported only for BrokerTec and EBS.
GFS is supported only for EBS.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9768 OFMOverride OFMOverrideReq 1 Y - OFMOverride=0 (Disabled)
- OFMOverride=1 (Enabled)
Flag indicating whether the cancel/replace supports iLink Order Cancel-Replace and In-Flight Mitigation to prevent overfilling. Once enabled in the order chain, OFMOverride cannot be disabled. 18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets (i.e. tag 18=00000000).
An order cancel/replace request submitted with tag 18 instructions for futures and options markets will be rejected with 35=j, except:
- Limit FAK orders submitted with Not Held instruction
- Market FAK orders submitted with Not Held instruction
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable only for US & EU Repos:
- ExecutionMode change from passive to aggressive not allowed
- ExecutionMode change from aggressive to passive only allowed for Managed Orders
An Order Cancel/Replace Request submitted with tag 5906 = P will be rejected for Non-Repo fixed income, EBS, and futures and options markets
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
New Orders submitted with tag 6881 = 1 will be rejected for futures and options markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption SESH
- 2=Short Sale With Exemption SSEX
- 3=Undisclosed Sell Information Not Available UNDI
Indicates the type of short sale on Sell orders only as required for MIFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
-
Page:iLink 3 Order Cancel Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
37 OrderID uInt64NULL 8 N Globally unique identifier for each order assigned by the exchange.
Required for BrokerTec.
Optional for F&O and EBS.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of the order to be cancelled.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
-
Page:iLink 3 Execution Report - Trade Outright (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill. 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (Conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
548 CrossID uInt64NULL 8 N Identifier for a Cross order. Will be present if execution report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 14 CumQty uInt32 4 Y Total quantity filled. 37711 MDTradeEntryID uInt32 4 Y Market Data Trade Entry ID. This identifier is assigned to all trades that take place for an instrument at a particular price level. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 820 TradeLinkID uInt32NULL 4 N Contains the workup ID; unique per instrument per day. 151 LeavesQty uInt32 4 Y Quantity open for further execution.
Only present for outrights and spreads, not spread legs.
75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatusTrd 1 Y - OrdStatus=1 (Partially Filled)
- OrdStatus=2 (Filled)
Identifies status of order as partially filled or completely filled. 150 ExecType ExecTypTrade 0 Y ExecType=F (Trade)
Describes the specific Execution Report (e.g. Cancel) while tag 39-OrdStatus will always identify the current order status (e.g. Partially Filled).
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
1057
AggressorIndicator
BooleanFlag 1 Y - AggressorIndicator=0 (No)
- AggresorIndicator=1 (Yes)
Indicates if order was incoming or resting for the match event.
549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross submitted to the market (if in response to a Cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MIFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7191 Ownership uInt8 1 N Specifies the owner of the work up private phase.
- 0 – Aggressive owner included in workup
- 1 – Passive owner included in workup
- 2 – Aggressive owner fill price from order excluded from workup during sweep
- 3 – Passive owner fill price from order excluded from workup during sweep
- 9 - Not Applicable
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
828 TradeType uInt16NULL 2 N - 1000=Trade at Fixing
Represents a trade at fixing price 378 ExecRestatementReason ExecReason 1 N - ExecRestatementReason=8 (Exchange)
Will be present when trade at fixing is assigned fixing price 64 SettlDate LocalMktDate 2 N Specific date of trade settlement 541 MaturityDate LocalMktDate 2 N Date of maturity 1056 CalculatedCcyLastQty Decimal64NULL 9 N Total amount traded (in notional) in counter currency for the Spot
381 GrossTradeAmt Decimal64NULL 9 N Total amount traded (in notional) in base currency for the Spot 6262 BenchmarkPrice PRICENULL9 8 N The price assigned to an eFix matched trade which is determined by an automated set market mid-price from a third
party market data feed. The Fixing Price will be distributed as soon as practicable after the Fixing Time1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report →1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills(1362) > 0. Same as LastPx(31) →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills(1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
22 – Institutional Prioritization
23 - Price Discretion
24 (LOS)
Enumeration of the Fill Reason field using Integer. Identifies the type of match algorithm 1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100.
Applicable for BrokerTec and EBS Market only.
→ 1799 OrderEventPx PRICE9 8 Y Refers to the fill price; same as LastPx (tag 31) → 1802 OrderEventText String5 5 N Will not be present for BrokerTec US; Will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades
Will be populated with the Settlement Counterparty Public ID for EBS Market.→ 1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; It will be unique per instrument per day
For EBS and BrokerTec US and EU Repo markets: this tag will be globally unique across all EBS and Repo instruments. Uniqueness is guaranteed within the configured range per market segment.
Note
For EBS customers, this field is equivalent to the Deal ID in Ai.→ 1800 OrderEventQty uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order → 1796 OrderEventType OrderEventType 1 Y - 4=Partially Filled
- 5=Filled
The type of event affecting an order → 1798 OrderEventReason uInt8 1 Y - 100=Binary Trade Reporting
Action that caused the event to occur → 5542 ContraGrossTradeAmt Decimal64NULL 9 N Amount traded (in notional) in base currency for the Spot with this counterparty → 5971 ContraCalculatedCcyLastQty Decimal64NULL 9 N Amount traded (in notional) in counter currency for the Spot with this counterparty 9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
9264 DailyLimitPrice PRICENULL9 8
N Currently not supported.
The price at which opposite side orders are listed on the market. Sent only in fill messages for reservation price orders.
-
Page:iLink 3 Execution Report - Reject (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICENULL9 8 N Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order and echo the value on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
548 CrossID uInt64NULL 8 N Identifier for a Cross order. Will be present if Execution Report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Order quantity submitted by client. 110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
103 OrdRejReason uInt16 2 Y Code to identify reason for order rejection.
See BrokerTec Reject Codes for BrokerTec Markets.
See EBS Reject Codes for EBS Market
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
5904 DelayDuration uInt16NULL 2 N Not currently being used.
39 OrdStatus OrdStatusRej 0 Y - OrdStatus=8 (Rejected)
Identifies current status of order as rejected.
Constant value.
150 ExecType ExecTypRej 0 Y - ExecType=8 (Rejected)
Describes the specific Execution Report while tag 39-OrdStatus will always identify the current order status.
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross submitted to the market (if in response to a Cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
-
Page:iLink 3 New Order - Single (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
44 Price PRICENULL9 8 N Price per share or contract. Conditionally required if the order type requires a price (not market orders). 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
- New Order - Single submitted with quantity greater than 99999 will be rejected with a Business Level Reject (35=j) message.
- New Order - Single submitted with quantity greater than the Max Quantity and less than 99999 will be rejected with an Execution Report - Reject (35=8) message.
Maximum Quantity is defined in the market data Security Definition(35=d) message in tag 1140-MaxTradeVol.- Note - the CME Globex maximum quantity limit per instrument also serves as an effective constraint on the maximum order value as required by MiFID II.
For EBS, this is the notional value instead of the lot size.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message.
54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 99 StopPx PRICENULL9 8 N The stop price of a stop limit or stop protect order (conditionally required if tag 40-OrdType=3 or 4). 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
For EBS, this is the notional value instead of the lot size.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
For EBS, this is the notional value instead of the lot size.
432 ExpireDate LocalMktDate 2 N Date of order expiration (last day the order can trade), always expressed in terms of the local market date. Applicable only to GTD orders, which expire at the end of the trading session specified.
Sent in number of days since Unix epoch.
40 OrdType OrderTypeReq 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=3 (Stop order with protection)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is only for BrokerTec and EBS
GFS is only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets;
- should not be used for future and options markets (i.e. tag 18=00000000)
New orders submitted with tag 18 instructions for futures and options markets will be rejected with 35=j, except:
- Limit FAK orders submitted with Not Held instruction
- Market FAK orders submitted with Not Held instruction
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
New Orders submitted with tag 5906 = P will be rejected for Non-Repo fixed income, EBS, and futures and options markets
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
New Orders submitted with tag 6881 = 1 will be rejected for futures and options markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption SESH
- 2=Short Sale With Exemption SSEX
- 3=Undisclosed Sell Information Not Available UNDI
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
-
Page:iLink 3 Execution Report - Status (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Only for descriptive rejects.
17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICENULL9 8 N Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (Conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time to millisecond accuracy.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
790 OrdStatusReqID uInt64NULL 8 N Used to uniquely identify a specific Order Status Request message. 584 MassStatusReqID uInt64NULL 8 N Unique ID of Order Mass Status Request as assigned by the client system. 548 CrossID uInt64NULL 8 N Identifier for a Cross order. Will be present if Execution Report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
14 CumQty uInt32 4 Y Total quantity filled. 151 LeavesQty uInt32 4 Y Quantity open for further execution.
Only present for outrights and spreads, not spread legs.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
432 ExpireDate LocalMktDate 2 N Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
39 OrdStatus OrderStatus 1 Y - OrdStatus=0 (New)
- OrdStatus=1 (Partially Filled)
- OrdStatus=2 (Filled)
- OrdStatus=4 (Cancelled)
- OrdStatus=5 (Replaced)
- OrdStatus=C (Eliminated)
- OrdStatus=8 (Rejected)
- OrdStatus=U (Undefined)
- OrdStatus=6 (Pending Cancel)
- OrdStatus=E (Pending Replace)
Identifies status of order 150 ExecType ExecTypStatus 0 Y ExecType=I (Status)
Describes the specific Execution Report as order status.
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
- Side=7 (Undisclosed)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=6 (GTD)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec
1028 ManualOrderIndicator ManualOrdIndReq
1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
912 LastRptRequested BooleanNULL 1 N - LastRptRequested=0 (No)
- LastRptRequested=1 (Yes)
Indicates whether this message is the last report message in response to an Order Mass Status Request. Required if responding to a Order Mass Status Request. 549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross submitted to a market (if in response to a cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
2807
CancelText
String8 8 N
Represents the SenderComp which initiates the cancellation of orders or quotes for the original SenderComp.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
-
Page:iLink 3 Execution Report Pending Replace (Electronic Platform Information Console) —
Tag
Field Name
Binary Type
Binary Length
Required
Value
Description
9726 SeqNum uInt32 4 Y Sequence number of this message 39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by the buy-side (institution, broker, intermediary etc.). Uniqueness must be guaranteed within a single trading day. Firms, particularly those which electronically submit multi-day orders, trade globally or throughout market close periods, should ensure uniqueness across days, for example by embedding a date within the ClOrdID field 1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the PartyDetailsDefinitionRequestAck attached to this message; pancake flip of what was submitted on inbound message
For short messages:
- PartyDetailsDefinitionRequestAck message would have been sent beforehand and that unique ID should be provided here
- PartyDetailsListReqID≠0
For long messages:
- If not registered beforehand through iLink then PartyDetailsDefinitionRequestAck message will be sent along with the business message and will immediately precede it
- PartyDetailsListReqID=0
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange. 44 Price PRICE9 8 Y Price per share or contract 60 TransactTime uInt64 8 Y Time the transaction represented by this ExecutionReport (35=8) occurred. Expressed as nanoseconds since epoch time 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify or delete an order and echo the value on the ExecutionReport
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined by CME. For the security ID list, see the security definition messages. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered
14 CumQty uInt32 4 Y Total quantity filled
Will be set to 0 for OFMOverride=0 (Disabled)
Will be set to total quantity filled for OFMOverride=1 (Enabled)
151 LeavesQty uInt32 4 Y Quantity open for further execution.
Only present for outrights and spreads, not spread legs.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed . Required for iceberg orders. On orders specifies the qty to be displayed, on execution reports the currently displayed quantity
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date
Default: days since Unix epoch. Range: Jan. 1, 1970 - June 7, 2149 local
39 OrdStatus PendModStatus 0 Y - OrdStatus=E (Pending Replace)
Identifies status of order as subject to pending replace
Constant value
150 ExecType ExecTypePendModify 0 Y - ExecType=E (Pending Replace)
Describes the specific ExecutionRpt as subject to pending cancellation
Constant value
40 OrdType OderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually or generated by automated trading logic 9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
This will convey whether a message is an original transmission or duplicate in response to RetransmissionRequest
This will become pertinent when original messages get interleaved with Retransmission responses
Possible duplicate means that same message could have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates whether a message was delayed as a result of being split among multiple packets (0) or if a message was delayed as a result of TCP re-transmission (1) or if a complete message was delayed due to a previously submitted split or out of order message (2). If absent then the message was not delayed and was neither split nor received out of order 9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU MiFID.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7552 DelayToTime uInt64NULL 8 N Indicates the amount of time that a message was delayed as a result of being split (9553=0) or as a result of being out of order due to TCP retransmission (9553=1) or as a result of being queued behind a split message (9553=2)
Represented as number of nanoseconds in unix epoch format (since Jan 1, 1970)
Subtracting this number from Tag 60 will represent original received time of delayed message
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority. -
Page:iLink 3 Execution Report Pending Cancel (Electronic Platform Information Console) —
Tag
Field Name
Binary Type
Binary Length
Required
Value
Description
9726 SeqNum uInt32 4 Y Sequence number of this message 39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by the buy-side (institution, broker, intermediary etc.). Uniqueness must be guaranteed within a single trading day. Firms, particularly those which electronically submit multi-day orders, trade globally or throughout market close periods, should ensure uniqueness across days, for example by embedding a date within the ClOrdID field 1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the PartyDetailsDefinitionRequestAck attached to this message; pancake flip of what was submitted on inbound message
For short messages:
- PartyDetailsDefinitionRequestAck message would have been sent beforehand and that unique ID should be provided here
- PartyDetailsListReqID≠0
For long messages:
- If not registered beforehand through iLink then PartyDetailsDefinitionRequestAck message will be sent along with the business message and will immediately precede it
- PartyDetailsListReqID=0
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract 60 TransactTime uInt64 8 Y Time the transaction represented by this ExecutionReport (35=8) occurred. Expressed as nanoseconds since epoch time 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify or delete an order and echo the value on the ExecutionReport
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined by CME. For the security ID list, see the security definition messages. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered
14 CumQty uInt32 4 Y Total quantity filled
Will be set to 0
151 LeavesQty uInt32 4 Y Quantity open for further execution.
Only present for outrights and spreads, not spread legs.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed . Required for iceberg orders. On orders specifies the qty to be displayed, on execution reports the currently displayed quantity
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date
Default: days since Unix epoch. Range: Jan. 1, 1970 - June 7, 2149 local
39 OrdStatus OrdStatusPendCxl 0 Y OrdStatus=6 (Pending Cancel)
Identifies status of order as subject to pending cancellation
Constant value
150 ExecType ExecTypePendCxl 0 Y ExecType=6 (Pending Cancel)
Describes the specific ExecutionRpt as subject to pending cancellation
Constant value
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq
1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually or generated by automated trading logic 9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
This will convey whether a message is an original transmission or duplicate in response to RetransmissionRequest or possible duplicate
This will become pertinent when original messages get interleaved with Retransmission responses
Possible duplicate means that same message could have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates whether a message was delayed as a result of being split among multiple packets (0) or if a message was delayed as a result of TCP re-transmission (1) or if a complete message was delayed due to a previously submitted split or out of order message (2). If absent then the message was not delayed and was neither split nor received out of order 9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
7552 DelayToTime uInt64NULL 8 N Indicates the amount of time that a message was delayed as a result of being split (9553=0) or as a result of being out of order due to TCP retransmission (9553=1) or as a result of being queued behind a split message (9553=2)
Represented as number of nanoseconds in unix epoch format (since Jan 1, 1970)
Subtracting this number from Tag 60 will represent original received time of delayed message
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
2807
CancelText
String8 8 N
Represents the SenderComp which initiates the cancellation of orders or quotes for the original SenderComp.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority. -
Page:iLink 3 Execution Report - Elimination (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order and echo the value on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
548 CrossID uInt64NULL 8 N Identifier for a cross order. Will be present if execution report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 14 CumQty uInt32 4 Y Total quantity filled.
This tag gets reset back to 0 with cancel, elimination, and non- IFM modification.
38 OrderQty uInt32 4 Y Order quantity submitted by client. 110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
39 OrdStatus OrdStatusExp 0 Y - OrdStatus=C (Expired)
Identifies status of order as eliminated.
Constant value.
150 ExecType ExecTypeExp 0 Y - ExecType=C (Expired)
Describes the specific Execution Report while tag 39-OrdStatus always identifies the current order status.
Constant value.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
549 CrossType uInt8NULL 1 N - CrossType=3
Type of cross submitted to the market (if in response to a cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
-
Page:iLink 3 Execution Report - Cancel (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit or stop protect order (conditionally required if tag 40-OrdType=3 or 4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
548 CrossID uInt64NULL 8 N Identifier for a cross order. Will be present if Execution Report is in response to a cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
14 CumQty uInt32 4 Y Total quantity filled.
This tag gets reset back to 0 with cancel, elimination, and non- IFM modification.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
5904 DelayDuration uInt16NULL 2 N Not currently being used.
39 OrdStatus OrdStatusCxl 0 Y OrdStatus=4 (Cancelled)
Identifies status of order as Cancelled.
Constant value.
150 ExecType ExecTypeCxl 0 Y ExecType=4 (Cancelled)
Describes the specific Execution Report as cancelled.
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec and EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq
1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
Note: this tag will contain the resting value attached with the order regardless of how the cancel itself was submitted.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
378 ExecRestatementReason ExecReason 1 N - ExecRestatementReason=8 (Exchange)
- ExecRestatementReason=9 (Cancelled Not Best)
- ExecRestatementReason=100 (Cancel on Disconnect)
- ExecRestatementReason=103 (Cancel Resting due to Self Match Prevention)
- ExecRestatementReason=104 (Cancel from CME Globex Credit Controls violation)
- ExecRestatementReason=105 (Cancel from CME One)
- ExecRestatementReason=106 (Cancel from Risk Management API)
- ExecRestatementReason=107 (Cancel Aggressing due to Self Match Prevention)
- ExecRestatementReason=108 (Cancel due to min qty violation)
- ExecRestatementReason=109 (Cancel RFC Order)
- ExecRestatementReason=110 (Cancel upon Contract Expiration)
- ExecRestatementReason=111 (System Cancel)
Used to communicate unsolicited cancels.
- ExecRestatementReason=9 (Cancelled Not Best) for fixed income markets only
549 CrossType uInt8NULL 1 N - CrossType=3
Type of cross being submitted to a market (if in response to a Cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
2807
CancelText
String8 8 N
Represents the SenderComp which initiates the cancellation of orders or quotes for the original SenderComp.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
-
Page:iLink 3 Execution Report - Modify (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order and echo the value on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
548 CrossID uInt64NULL 8 N Identifier for a cross order. Present if Execution Report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a cross: sides + strategy + legs.
The HostCrossID is also used to link components of the cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
14 CumQty uInt32 4 Y Total quantity filled.
This tag gets reset back to 0 with cancel, elimination, and non- IFM modification.
151 LeavesQty uInt32 4 Y Quantity open for further execution.
Only present for outrights and spreads, not spread legs.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
5904 DelayDuration uInt16NULL 2 N Not currently being used.
39 OrdStatus ModifyStatus 0 Y - OrdStatus=5 (Replaced)
Identifies current status of order.
Constant value.
150 ExecType ExecTypeModify 0 Y - ExecType=5 (Replaced)
Describes the specific Execution Report (e.g. Cancel Replace) .
Constant value.
40 OrdType OderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported only for EBS
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross submitted to the market (if in response to a cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Ony Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
-
Page:iLink 3 Execution Report - New Order (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (Conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order and echo the value on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
548 CrossID uInt64NULL 8 N Identifier for a Cross order. Present if Execution Report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Number of shares or contracts ordered.
110 MinQty uInt32NULL 4 N Minimum quantity of an order for immediate execution.
The value of MinQty must be between 1 and the value in tag 38-OrderQty.
If set to 0 or default null value then it means that minimum quantity is n.
If the quantity present in tag 110 cannot be immediately executed, the entire order is eliminated.
1138 DisplayQty uInt32NULL 4 N The quantity to be displayed. Required for display quantity orders.
Note: on orders, this value specifies the qty to be displayed; on Execution Reports this value indicates the currently displayed quantity.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
5904 DelayDuration uInt16NULL 2 N Not currently being used.
39 OrdStatus OrdStatusNew 0 Y OrdStatus=0 (New)
Identifies status of order as new.
Constant value.
150 ExecType ExecTypNew 0 Y ExecType=0 (New)
Describes the specific Execution Report as new.
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies how long the order remains in effect
FOK is supported only for BrokerTec/EBS
GFS is supported for EBS
1028 ManualOrderIndicator ManualOrdIndReq
1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross being submitted to a market (if in response to a Cross order).
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Ony Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
845 DiscretionPrice PRICENULL9 8 N The discretion price of an order. Conditionally required if the trader wishes to display one price but will accept trades at another price)
- The discretion price for a bid must be greater than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.06)
- The discretion price for an ask must be less than the shown Limit price (e.g. Buy order: tag 44-Price = 115.05; tag 845-DiscretionPrice = 115.04)
Applicable only for EBS.
9562 ReservationPrice PRICENULL9 8 N Currently not supported.
This field specifies the highest (for a buy) or lowest (for a sell) price at which the order may trade. This price must be better than the limit price and should be a multiple of reservation price tick.
638 PriorityIndicator ulnt8NULL 1 N - Tag 638=100 (Large Order Size Priority)
- Tag 638=101 (Standard Order Size Priority)
Indicates whether an incoming New Order/Cancel-Replace entered the book or subsequently rests on the book with Large Order Size or Standard Order Size priority.
-
Page:iLink 3 Security Definition Response (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
2714 FinancialInstrumentFullName StringLength35 35 N Long name of the instrument for TM Repo. 5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
55 Symbol String20 20 N Instrument Short Name for TM Repo. 1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
320 SecurityReqID uInt64 8 Y Unique ID of a Security Definition Request. 322 SecurityResponseID uInt64 8 Y Unique ID of a Security Definition message. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 1151
SecurityGroup
StringLength6
6
N Product group 167 SecurityType StringLength6 6
N - FUT = Future or Future Spread
- OOF = Options on Futures or Options on Futures Spread
- MLEG = Strategy with mixed type legs
Security Type
Note: For UDS for Futures, only returned in UDS acknowledgments (tag 323-SecurityResponseType=2). It is not returned in rejects (323-SecurityResponseType=5)
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48
SecurityID
Int32NULL
4
N Identifier of the UDS/UDI. 15
Currency
String3
3
N Identifies currency used for price. 22
SecurityIDSource
SecurityIDSource
0
Y Always 4=ISIN number Identifies class or source of the tag 48-SecurityID value.
Constant value.
200
MaturityMonthYear
MaturityMonthYear 2
N Instrument expiration; earliest leg maturity in the options strategy.
Format YYYYMM (i.e. 200912)
For daily products, this tag contains the full calendar date as reflected in the instrument symbol. Format YYYYMMDD (e.g. 20191205).
For weekly options products, this tag contains the calendar month and week indicator reflected in the instrument symbol. Format YYYYMMwW (e.g., for the 4th week contracts, 201912W4).
5904 DelayDuration uInt16NULL 2 N Not currently being used.
916 StartDate LocalMktDate 2 N Start date of a financing deal, i.e. the date the buyer pays the seller cash and takes control of the collateral. 917 EndDate LocalMktDate 2 N End date of a financing deal, i.e. the date the seller reimburses the buyer and takes back control of the collateral. 37715 MaxNoOfSubstitutions uInt8NULL 1 N Max number of substitutions allowed. '0 ' indicates that substitutions are not allowed. 5677 SourceRepoID Int32NULL 4 N Represents the source repo instrument on which the new tailor made repo should be modeled on 788 TerminationType String8 8 N Represents the term code 323 SecurityResponseType SecRspTyp 1 Y - SecurityRequestType=1 (not used)
- SecurityResponseType=2 (Accept security proposal
with revisions as indicated
in the message) - SecurityResponseType=5 (Reject security proposal)
Type of response. 9779
UserDefinedInstrument
UDI
0
Y - Y=User defined instrument
Identifies user-defined instruments
Constant value
827
ExpirationCycle
ExpCycle
1
N - 0=Expire on trading session close (default)
- 2=Trading eligibility expiration specified in the date and time fields
For tag 827-ExpirationCycle=2, instrument expires as indicated in market data Security Definition (tag 35-MsgType=d) repeating block:
- Tag 865-EventType=7 (Last Eligible Trade Date)
- Tag 1145-EventTime
1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
9776
AutoQuoteRequest
BooleanFlag 1
Y - 0=False
- 1=True
Boolean flag (0/1) to automatically send a quote request message following the Security Definition (35=d) message.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
6651 BrokenDateTermType uInt8NULL 1 N Currently not supported.
Defines how user defined tailor made repo contract is to be broken down into different broken dates.
555 NoLegs groupSize 3 Y - minValue=2
- maxValue=40
Up to 26 legs (i.e., repeating groups) supported for UDS for options. Up to 40 legs (i.e., repeating groups) supported for UDS for futures. →566 LegPrice PRICENULL9 8 N Price of the futures contract as part of UDS Covered. →1017 LegOptionDelta Decima32NULL 4 N Delta used to calculate the quantity of futures used to cover the option or option strategy.
- For a covered option outright instrument, must be between +0.01 and +1.00.
- For a covered option spread instrument, must be between +0.01 and +40.00
→603 LegSecurityIDSource LegSecIDSource 0 Y - LegSecurityIDSource=8 (exchange symbol)
Identifies class or source of the tag 602-LegSecurityID value.
Constant value.
→602 LegSecurityID Int32 4 Y ISIN code, this is the primary tag used to identify the contract and it must be populated with the corresponding tag 48-SecurityID value from the market data 35=d Security Definition message. →624 LegSide SideReq 1 Y - LegSide=1 (Buy)
- LegSide=2 (Sell)
For Covereds, must be present for option repeating group and must = 1 (buy).
For Covereds, must be present for future repeating group as well.
For Combos, the first instrument in the repeating group must = 1 (buy).
All UDS contract are defined from the buy side perspective (i.e. buying the spread).
→623 LegRatioQty uInt8NULL Enum 1 N - minValue=1
- maxValue=20
Specifies ratio for the instrument defined in this repeating group.
Required for any UDS options leg.
Optional for Covereds leg.
39026 NoBrokenDates groupSize 3 Y Currently not supported.
Used to indicate the number of custom bespoke broken dates for user defined tailor made repo.
→39031 BrokenDateGUID uInt64NULL 8 N External unique REPO Instrument ID.
→39027 BrokenDateSecurityID Int32NULL 4 N REPO Instrument Security ID.
→6748 BrokenDateStart LocalMktDate 2 Y Start date of a financing deal, i.e. the date the buyer pays the seller cash and takes control of the collateral.
→6741 BrokenDateEnd LocalMktDate 2 Y End date of a financing deal, i.e. the date the seller reimburses the buyer and takes back control of the collateral. -
Page:iLink 3 Security Definition Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
320 SecurityReqID uInt64 8 Y Unique ID of a Security Definition Request. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
321 SecurityReqType SecurityReqType 0 Y - SecurityRequestType=1
Type of Security Definition Request.
Constant value.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 762 SecuritySubType String8Req 8 Y - COMBO
- COVERED
- REPO
Identifies specific type of UDS; valid values are COMBO, COVERED, and REPO.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
916 StartDate LocalMktDate 2 N Start date of a financing deal, i.e. the date the buyer pays the seller cash and takes control of the collateral. 917 EndDate LocalMktDate 2 N End date of a financing deal, i.e. the date the seller reimburses the buyer and takes back control of the collateral. 37715 MaxNoOfSubstitutions uInt8NULL 1 N Max number of substitutions allowed. The value of 0 indicates that substitutions are not allowed.
Applicable for US Repos.
5677 SourceRepoID Int32NULL 4 N Represents the source Repo instrument on which the new Repo should be modeled. 6651 BrokenDateTermType uInt8NULL 1 N Currently not supported.
Defines how user defined tailor made repo contract is to be broken down into different broken dates.
555 NoLegs groupSize 3 Y - minValue=2
- maxValue=40
UDS cannot exceed supported max number of legs.
- UDS on options - 40 legs
- Recursive UDS - no more than 40 instruments that make up the Recursive
- UDS on futures - 40 legs
Will be set to 0 for REPO
- An iLink Security Definition Request (tag 35-MsgType=c) is rejected as "'Too Many Legs for combo combo: <option/future leg count> Max: <max option/future leg>" due to tag 555 is more than 40
An iLink Security Definition Request (tag 35-MsgType=c) is rejected as "'Not Enough Legs: <leg count> Min: 2'" due to tag 555 is less than 2
→603 LegSecurityIDSource LegSecIDSource 0 Y - LegSecurityIDSource=8 (exchange symbol)
Identifies class or source of the tag 602-LegSecurityID.
Constant value.
→566 LegPrice PRICENULL9 8 N Price of the futures contract as part of UDS Covered →602 LegSecurityID Int32 4 Y ISIN code, this is the primary tag used to identify the contract and it must be populated with the corresponding tag 48-SecurityID value from the market data 35=d Security Definition message. →1017 LegOptionDelta Decimal32NULL 4 N Delta used to calculate the quantity of futures used to cover the option or option strategy.
- For a covered option outright instrument, must be between +0.01 and +1.00.
- For a covered option spread instrument, must be between +0.01 and +40.00.
The exponent cannot be greater than 0 and it can either be null or between -5 and 0.
→624 LegSide SideReq 1 Y - LegSide=1 (Buy)
- LegSide=2 (Sell)
For Covereds, must be present for option repeating group and must = 1 (buy).
For Covereds, must be present for future repeating group as well.
For Combos, the first instrument in the repeating group must = 1 (buy).
All UDS contracts are defined from the buy side perspective (i.e. buying the spread).
→623 LegRatioQty uInt8NULL 1 N - minValue=1
- maxValue=20
Specifies ratio for the instrument defined in this repeating group.
Required for any UDS options leg.
Optional for Covereds leg.39026 NoBrokenDates groupSize 3 Y Currently not supported.
Used to indicate the number of custom bespoke broken dates for user defined tailor made repo
→6748 BrokenDateStart LocalMktDate 2 Y Start date of a financing deal, i.e. the date the buyer pays the seller cash and takes control of the collateral
→6741 BrokenDateEnd LocalMktDate 2 Y End date of a financing deal, i.e. the date the seller reimburses the buyer and takes back control of the collateral -
Page:iLink 3 Order Mass Status Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
584 MassStatusReqID uInt64 8 Y Unique ID of Order Mass Status Request as assigned by the customer. Echoed back in Execution Report.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 1151 SecurityGroup StringLength6 6 N Conditionally required if OrderStatusRequestType=“Product Group” (tag 585=3).
Status for working orders belonging to this particular product group will be returned.
Will be ignored if present for any other criteria specified in OrderStatusRequestType besides product group (tag 585=3).
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32NULL 4 N Conditionally required if OrderStatusRequestType=”Instrument” (Tag 585=1).
Status for working orders belonging to this particular instrument will be returned.
Will be ignored if present for any other criteria specified in OrderStatusRequestType besides Instrument.
585 MassStatusReqType MassStatusReqTyp 1 Y - MassStatusRequestType=1 (Instrument)
- MassStatusRequestType=3 (Product Group)
- MassStatusRequestType=7 (All Orders)
Applicable for iLink 3 CGW only - MassStatusRequestType=100 (Market Segment)
Specifies the scope of the Order Mass Status Request within the context of working orders only. Status will be returned for all orders matching the criteria specified here for Session and Firm.
5000 OrdStatusReqType MassStatusOrdTyp 1 N OrdStatusReqType=100 (Operator ID)
OrdStatusReqType=101 (Account)
If present – specifies the scope of the Order Mass Status Request within the context of MassStatusRequestType (tag 585) and Session and Firm for working orders only.
Status will be returned for all orders matching the criteria specified here for Session and Firm combination.
59 TimeInForce MassStatusTIF 1 N - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=6 (GTD)
- TimeInForce=99 (GFS)
Specifies the scope of the OrderMassStatusRequest within the context of MassStatusRequestType (585) if present. Absence of this field is interpreted as all working orders. FAK and FOK are excluded since scope is limited to working orders only
GFS is applicable for EBS only.
1300 MarketSegmentID uInt8NULL 1 N Conditionally required if OrderStatusRequestType=“Market Segment” (tag 585=100). Status for working orders belonging to this particular market segment will be returned. Will be ignored if present for any other criteria specified in OrderStatusRequestType besides market segment (tag 585=100).
-
Page:iLink 3 Party Details Definition Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 1324 ListUpdateAction ListUpdAct 1 Y A=Add
D=Delete (TBD)
Indicates if all of the information sent in this message with a unique new PartyDetailsListReqID is a new addition or deletion of existing information associated with an existing PartyDetailsListReqID.
For PartyDetailsListReqID=0 this should always be set to "A".
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5149 Memo String75 75 N This general purpose text field can be mapped from iLink to Clearing STP for trades.
1731 AvgPxGroupID String20 20 N Used by submitting firm to group trades being allocated into an average price group.
The trades in average price group will be used to calculate an average price for the group.
Not applicable for fixed income and EBS markets.
2362 SelfMatchPreventionID uInt64NULL 8 N Identifies an order or trade that should not be matched to an opposite order or trade if both buy and sell orders for the same asset contain the same tag 2362-SelfMatchPreventionID and were submitted by the same firm. 9708 CmtaGiveupCD CmtaGiveUpCD 1 N G=GiveUp
S=SGX Offset
Indicates if the order is a give-up or SGX offset.
Not applicable for fixed income and EBS markets.
582 CustOrderCapacity CustOrderCapacity 1 N 1=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 CTI 2 transactions.
2=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.
3=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
4=Applies to all orders and transactions not included in CTI categories 1, 2, or 3. These typically are orders entered by or on behalf of nonmember entities.
Capacity of customer placing the order.
Used by futures exchanges to indicate the CTICode (customer type indicator) as required by the US CFTC (Commodity Futures Trading Commission).
Not applicable for fixed income and EBS markets.
1816 ClearingAccountType ClearingAcctType 1 N 0=Customer
1=Firm
Designates the account type to use for the order when submitted to clearing.
Required for CME Group futures and options only.
Not applicable for fixed income and EBS markets.
8000 SelfMatchPreventionInstruction SMPI 1 N N=Cancel Newest
O=Cancel Oldest
Used to act upon the outcome when a self-match is detected and an order is prevented from trading against another order with the same tag 2362-SelfMatchPreventionID.
N=Cancel newest signifies that incoming order is cancelled.
O=Cancel Oldest signifies that the resting order is cancelled.
Absence of this field (with tag 2362) is interpreted as cancel oldest.
819 AvgPxIndicator AvgPxInd 1 N 0=No average pricing
1=Trade is part of an average price group identified by the AvgPxGroupID (tag 1731)
3=Trade is part of a notional value average price group
A notional value average price (NVAP) group is effectively closed and available for allocation as long as the NVAP of the group is non-zero
Average pricing indicator.
Not applicable for fixed income and EBS markets.
1598 ClearingTradePriceType SLEDS 1 N 0=Trade clearing at execution price
1=Trade clearing at alternate clearing price
Indicates to recipient whether trade is clearing at execution prices tag 31-LastPx or alternate clearing price (prior day settlement price).
Not applicable for fixed income and EBS markets.
1031 CustOrderHandlingInst CustOrdHandlInst 1 N - W - Desk
- Y - Electronic (Default)
- C - Vendor-provided Platform billed by Executing Broker
- G - Sponsored Access via Exchange API or FIX provided by Executing Broker
- H - Premium Algorithmic Trading Provider billed by Executing Broker
- D - Other, including Other-provided Screen
Defines source of original order.
Required for CME Group futures and options only.
5290 Executor uInt64NULL 8 N Will be populated with the MIFID short code for the person or algo that submitted the message. The short code will be mapped to National ID or Algo at reporting time.
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
36023 IDMShortCode uInt64NULL 8 N Represents the Investment Decision Maker Short Code
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
1676 NoPartyUpdates NoPtyUpd 0 Y Always "1"
Number of party updates.
Constant value of 1.
1671 NoPartyDetails groupSize 3 Y minValue=1
maxValue=5
Number of party details.
More than one occurrence of the same party role will be rejected.
→1691 PartyDetailID String20Req 20 Y The identification of the party. →1692 PartyDetailIDSource PartyIDSource 0 Y Always “C” – Generally accepted market participant identifier Used to identify source of PartyDetailID value.
Constant value.
→1693 PartyDetailRole PartyDetailRole 2 Y - PartyDetailRole=96 (take up firm)
- PartyDetailRole=1000 (take up account)
- PartyDetailRole=1 (executing firm)
- PartyDetailRole=118 (operator)
- PartyDetailRole=24 (customer account)
Identifies the type of PartyDetailID.
- PartyDetailRole=24 is required for futures and options markets.
- PartyDetailRole=1 is required for futures, options, EBS, and fixed income markets.
- PartyDetailRole=118 is required for futures, options, EBS, and fixed income markets. It represents the party responsible for submission of the message. This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
- PartyDetailRole= 96 represents the executing firm ID to which the fill is Given Up or mutually off-set for eligible contracts.
- PartyDetailRole=1000 represents a give up account number.
Note - PartyDetailRole=96 and 1000 are applicable only for futures and options markets. Must be used in conjunction with tag 9708-CmtaGiveupCD.
2668
NoTrdRegPublications
groupSize
3
N
Number of regulatory publication rules in repeating group for MIFID reporting.
Used to indicate that an ESCB customer can exempt from disclosure any activity that is related to central banking activity.
Should always be '1' if used otherwise set to '0'
→2669
TrdRegPublicationType
uInt8
1
Y
2=Exempt from Publication
Specifies the type of regulatory trade publication
Additional reasons for the publication type will be specified in tag 2670-TrdRegPublicationReason.
Represents allowable exemptions for the post-trade publication of trade transactions
Required when NoTrdRegPublications (tag 2668) > 0
Should always be '2'
→2670
TrdRegPublicationReason
uInt8
1
Y
12=Exempted due to European System of Central Banks (ESCB) policy transaction
Additional reason for trade publication type specified in tag 2669-TrdRegPublicationType.
Reasons may be specific to regulatory trade publication rules
Required when NoTrdRegPublications (tag 2668) > 0
Should always be '12'
-
Page:iLink 3 Party Details Definition Request Acknowledgment (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 5149 Memo String75 75 N This general purpose text field can be mapped from iLink to Clearing STP for trades.
1731 AvgPxGroupID String20 20 N Used by submitting firm to group trades being allocated into an average price group.
The trades in average price group will be used to calculate an average price for the group.
Not applicable for fixed income and EBS markets.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID sent in response to the Party Details Definition Request
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 2362 SelfMatchPreventionID uInt64NULL 8 N Identifies an order or trade that should not be matched to an opposite order or trade if both buy and sell orders for the same asset contain the same tag 2362-SelfMatchPreventionID and submitted by the same firm. 1878 PartyDetailRequestStatus uInt8 1 Y 0=Accepted Status of Party Details Definition Request. 582 CustOrderCapacity CustOrderCapacity 1 N 1=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 CTI 2 transactions.
2=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.
3=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
4=Applies to all orders and transactions not included in CTI categories 1, 2, or 3. These typically are orders entered by or on behalf of nonmember entities.
Capacity of customer placing the order.
Used by futures exchanges to indicate the CTICode (customer type indicator) as required by the US CFTC (Commodity Futures Trading Commission).
Not applicable for fixed income and EBS markets.
1816 ClearingAccountType ClearingAcctType 1 N 0=Customer
1=Firm
Designates the account type to be used for the order when submitted to clearing.
Required for CME Group futures and options only.
Not applicable for fixed income and EBS markets.
8000 SelfMatchPreventionInstruction SMPI 1 N N=Cancel Newest
O=Cancel Oldest
Used to determine the outcome when a self-match is detected and an order is prevented from trading against another order with the same SelfMatchPreventionID (tag 2362).
N=Cancel newest signifies that incoming order is cancelled.
O=Cancel Oldest signifies that the resting order is cancelled.
Absence of this field (with tag 2362) is interpreted as cancel oldest.
819 AvgPxIndicator AvgPxInd 1 N 0=No average pricing
1=Trade is part of an average price group identified by the AvgPxGroupID (tag 1731)
3=Trade is part of a notional value average price group
A notional value average price (NVAP) group is effectively closed and available for allocation as long as the NVAP of the group is non-zero
Average pricing indicator.
Not applicable for fixed income and EBS markets.
1598 ClearingTradePriceType SLEDS 1 N 0=Trade clearing at execution price
1=Trade clearing at alternate clearing price
Indicates to recipient whether trade is clearing at execution prices tag 31-LastPx or alternate clearing price (prior day settlement price).
Not applicable for fixed income and EBS markets.
9708 CmtaGiveUpCD CmtaGiveUpCD 1 N G=GiveUp
S=SGX Offset
Indicates if the order is a give-up or SGX offset.
Not applicable for fixed income and EBS markets.
1031 CustOrderHandlingInst CustOrdHandlInst 1 N - W - Desk
- Y - Electronic (Default)
- C - Vendor-provided Platform billed by Executing Broker
- G - Sponsored Access via Exchange API or FIX provided by Executing Broker
- H - Premium Algorithmic Trading Provider billed by Executing Broker
- D - Other, including Other-provided Screen
Defines source of original order.
Required for CME Group futures and options only.
1676 NoPartyUpdates NoPtyUpd 0 Y Always "1"
Number of party updates.
Constant value of 1.
1324 ListUpdateAction ListUpdAct 1 Y A=Add
D=Delete (TBD)
Indicates if all of the information sent in this message with a unique new PartyDetailsListReqID is a new addition or deletion of existing information associated with an existing PartyDetailsListReqID
For PartyDetailsListReqID=0 this should always be set to "A"
1879 PartyDetailDefinitionStatus uInt8 1 Y 0=Accepted Status of party detail definition for one party. 5290 Executor uInt64NULL 8 N Will be populated with the MIFID short code for the person or algo that submitted the message. The short code will be mapped to National ID or Algo at reporting time.
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
36023 IDMShortCode uInt64NULL 8 N Represents the Investment Decision Maker Short Code
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
1671 NoPartyDetails groupSize 3 Y minValue=1
maxValue=5
Number of party details.
More than one occurrence of the same party role will be rejected.
→1691 PartyDetailID String20Req 20 Y The identification of the party. →1692 PartyDetailIDSource PartyIDSource 0 Y Always “C” – Generally accepted market participant identifier Used to identify source of PartyDetailID value.
Constant value.
→1693 PartyDetailRole PartyDetailRole 2 Y - PartyDetailRole=96 (take up firm)
- PartyDetailRole=1000 (take up account)
- PartyDetailRole=1 (executing firm)
- PartyDetailRole=118 (operator)
- PartyDetailRole=24 (customer account)
Identifies the type of PartyDetailID.
- PartyDetailRole=24 is required for futures and options markets.
- PartyDetailRole=1 is required for futures, options, EBS, and fixed income markets.
- PartyDetailRole=118 is required for futures, options, EBS, and fixed income markets. It represents the party responsible for submission of the message. This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
- PartyDetailRole= 96 represents the executing firm ID to which the fill is given up or mutually off-set for eligible contracts.
- PartyDetailRole=1000 represents a give up account number.
Note - PartyDetailRole=96 and 1000 are applicable only for futures and options markets. Must be used in conjunction with tag 9708-CmtaGiveupCD.
2668
NoTrdRegPublications
groupSize
3
N
Number of regulatory publication rules in repeating group for MIFID reporting
Used to indicate that an ESCB customer can exempt from disclosure any activity that is related to central banking activity
Should always be '1' if used otherwise set to '0'
→2669
TrdRegPublicationType
uInt8
1
Y
2=Exempt from Publication
Specifies the type of regulatory trade publication
Additional reasons for the publication type will be specified in tag 2670-TrdRegPublicationReason
Represents allowable exemptions for the post-trade publication of trade transactions
Required when NoTrdRegPublications (tag 2668) > 0
Should always be "2"
→2670
TrdRegPublicationReason
uInt8
1
Y
12=Exempted due to European System of Central Banks (ESCB) policy transaction
Additional reason for trade publication type specified in tag 2669-TrdRegPublicationType (2669)
Reasons may be specific to regulatory trade publication rules
Required when NoTrdRegPublications (tag 2668) > 0
Should always be "12"
-
Page:iLink 3 Party Details List Report (Electronic Platform Information Console) —
Tag
Field Name
Binary Type
Binary Length
Required
Value
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 1731 AvgPxGroupID String20 20 N Used by submitting firm to group trades being allocated into an average price group.
The trades in average price group will be used to calculate an average price for the group.
Not applicable for fixed income and EBS markets.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
1510 PartyDetailsListReportID uInt64 8 Y Refers to the unique identifier of the Party Details List Request (35=CF) message used to request this Party Details List Report. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 2362 SelfMatchPreventionID uInt64NULL 8 N Identifies an order or trade that should not be matched to an opposite order or trade if both buy and sell orders for the same asset contain the same tag 2362-SelfMatchPreventionID and submitted by the same firm. 1512 TotNumParties uInt16 2 Y Indicates total number of Party Details List Reports being returned in response to Party Details List Request. 1511 RequestResult ReqResult 1 Y 0=Valid Request
2=No Data Found That Matched Selection Criteria
3=Not Authorized to Retrieve Data
4=Data Temporarily Unavailable
Status of party details list request. 893 LastFragment BooleanFlag 1 Y 0=False
1=True
Indicates whether this message is the last Party Details List Report in response to Party Details List Request. 582 CustOrderCapacity CustOrderCapacity 1 N 1=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 CTI 2 transactions.
2=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.
3=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
4=Applies to all orders and transactions not included in CTI categories 1, 2, or 3. These typically are orders entered by or on behalf of nonmember entities.
Capacity of customer placing the order.
Used by futures exchanges to indicate the CTICode (customer type indicator) as required by the US CFTC (Commodity Futures Trading Commission).
Not applicable for fixed income and EBS markets.
1816 ClearingAccountType ClearingAcctType 1 N 0=Customer
1=Firm
Designates the account type to be used for the order when submitted to clearing.
Required for CME Group futures and options only.
Not applicable for fixed income and EBS markets.
8000 SelfMatchPreventionInstruction SMPI 1 N N=Cancel Newest
O=Cancel Oldest
Used to act upon the outcome when a self-match is detected and an order is prevented from trading against another order with the same SelfMatchPreventionID (tag 2362).
N=Cancel newest signifies that incoming order is cancelled
O=Cancel Oldest signifies that the resting order is cancelled
Absence of this field (with Tag 2362) is interpreted as cancel oldest.
819 AvgPxIndicator AvgPxInd 1 N 0=No average pricing
1=Trade is part of an average price group identified by the AvgPxGroupID(1731)
3=Trade is part of a notional value average price group
A notional value average price (NVAP) group is effectively closed and available for allocation as long as the NVAP of the group is non-zero
Average pricing indicator.
Not applicable for fixed income and EBS markets.
1598 ClearingTradePriceType SLEDS 1 N 0=Trade clearing at execution price
1=Trade clearing at alternate clearing price
Indicates to recipient whether trade is clearing at execution prices tag 31-LastPx or alternate clearing price (prior day settlement price). 9708 CmtaGiveUpCD CmtaGiveUpCD 1 N G=GiveUp
S=SGX Offset
Indicates if the order is a give-up or SGX offset 1031 CustOrderHandlingInst CustOrdHandlInst 1 N - W - Desk
- Y - Electronic (Default)
- C - Vendor-provided Platform billed by Executing Broker
- G - Sponsored Access via Exchange API or FIX provided by Executing Broker
- H - Premium Algorithmic Trading Provider billed by Executing Broker
- D - Other, including Other-provided Screen
Defines source of original order.
Required for CME Group futures and options only.
5290 Executor uInt64NULL 8 N Will be populated with the MIFID short code for the person or algo that submitted the message. The short code will be mapped to National ID or Algo at reporting time.
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
36023 IDMShortCode uInt64NULL 8 N Represents the Investment Decision Maker Short Code
Conditionally required for EU BrokerTec and EBS MiFID regulated instruments. Messages missing this tag or containing an unregistered value will be rejected.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
1671 NoPartyDetails groupSize 3 N minValue=1
maxValue=5
Number of party details.
More than one occurrence of the same party role will be rejected.
→1691 PartyDetailID String20Req 20 Y The identification of the party. →1692 PartyDetailIDSource PartyIDSource 0 Y Always “C” – Generally accepted market participant identifier Used to identify source of PartyDetailID value.
Constant value.
→1693 PartyDetailRole PartyDetailRole 2 Y - PartyDetailRole=96 (take up firm)
- PartyDetailRole=1000 (take up account)
- PartyDetailRole=1 (executing firm)
- PartyDetailRole=118 (operator)
- PartyDetailRole=24 (customer account)
Identifies the type of PartyDetailID.
- PartyDetailRole=24 is required for futures and options markets.
- PartyDetailRole=1 is required for futures, options, EBS and fixed income markets.
- PartyDetailRole=118 is required for futures, options, EBS, and fixed income markets. It represents the party responsible for submission of the message. This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
- PartyDetailRole= 96 represents the executing firm ID to which the fill is given up or mutually off-set for eligible contracts.
- PartyDetailRole=1000 represents a give up account number.
Note - PartyDetailRole=96 and 1000 are applicable only for futures and options markets. Must be used in conjunction with tag 9708-CmtaGiveupCD.
2668
NoTrdRegPublications
groupSize
3
N
Number of regulatory publication rules in repeating group for MIFID reporting
Used to indicate that an ESCB customer can exempt from disclosure any activity that is related to central banking activity
Should always be '1' if used otherwise set to '0'
→2669
TrdRegPublicationType
uInt8
1
Y
2=Exempt from Publication
Specifies the type of regulatory trade publication
Additional reasons for the publication type will be specified in tag 2670-TrdRegPublicationReason
Represents allowable exemptions for the post-trade publication of trade transactions
Required when NoTrdRegPublications (tag 2668) > 0
Should always be "2"
→2670
TrdRegPublicationReason
uInt8
1
Y
12=Exempted due to European System of Central Banks (ESCB) policy transaction
Additional reason for trade publication type specified in tag 2669-TrdRegPublicationType (2669)
Reasons may be specific to regulatory trade publication rules
Required when NoTrdRegPublications (tag 2668) > 0
Should always be "12"
-
Page:iLink 3 Execution Report - Trade Spread (Electronic Platform Information Console) —
Tag
Field Name
Binary Type
Binary Length
Required
Value
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For fixed income markets: represents the Entering Trader.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
44 Price PRICE9 8 Y Price per share or contract. 99 StopPx PRICENULL9 8 N The stop price of a stop limit and stop protect order (Conditionally present if tag 40-OrdType=4). 60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order and echo the value on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
548 CrossID uInt64NULL 8 N Identifier for a Cross order. Will be present if Execution Report is in response to a Cross order. 961 HostCrossID uInt64NULL 8 N Host-assigned entity ID used to reference all components of a Cross: sides + strategy + legs.
The HostCrossID also links components of the Cross order. For example, each individual Execution Report associated with the order will contain HostCrossID to tie them to the original Cross order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 38 OrderQty uInt32 4 Y Order quantity submitted by client. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 14 CumQty uInt32 4 Y Total quantity filled. 37711 MDTradeEntryID uInt32 4 Y Market Data Trade Entry ID. This identifier is assigned to all trades that take place for an instrument at a particular price level. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 151 LeavesQty uInt32 4 Y Quantity open for further execution
LeavesQty = OrderQty (tag 38) - CumQty (tag 14)
Only present for outrights and spreads and not spread legs.
75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
432 ExpireDate LocalMktDate 2 Y Date of order expiration (last day the order can trade), always expressed in terms of the local market date.
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatusTrd 1 Y - OrdStatus=1 (Partially Filled)
- OrdStatus=2 (Filled)
Identifies status of order as partially filled or completely filled. 150 ExecType ExecTypTrade 0 Y ExecType=F (Trade)
Describes the specific ExecutionRpt (e.g. Cancel) while tag 39-OrdStatus will always identify the current order status (e.g. Partially Filled).
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 59 TimeInForce TimeInForce 1 Y - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=3 (FAK)
- TimeInForce=4 (FOK)
- TimeInForce=6 (GTD)
Specifies how long the order remains in effect.
FOK is only for BrokerTec
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
1057
AggressorIndicator
BooleanFlag 1 Y - AggressorIndicator=0 (No)
- AggresorIndicator=1 (Yes)
Indicates if order was incoming or resting for the match event.
549 CrossType uInt8NULL 1 N - CrossType=3
Type of Cross submitted to the market (if in response to a cross order).
393 TotalNumSecurities uInt8 1 Y Indicates total number of leg fills for the spread.
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and MiFID.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report.
Maximum number of fill reasons is 6.
→1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills (1362) > 0. Same as LastPx (31) →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason. →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills (1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation. →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
Enumeration of the Fill Reason field using Integer. This identifies the type of match algorithm. 555 NoLegs groupSize 3 N Number of Leg executions.
Currently not supported; set the groupSize to 0.
→1893 LegExecID uInt64 8 Y The tag 17-ExecID value corresponding to a trade leg. →637 LegLastPx PRICE9 8 Y Execution price assigned to a leg of a multileg instrument. →602 LegSecurityID Int32 4 Y Multileg instrument's individual security's SecurityID. →1894 LegTradeID uInt32 4 Y The TradeID value corresponding to a trade leg. →1418 LegLastQty uInt32 4 Y Fill quantity for the leg instrument. →624 LegSide SieReq 1 Y The side of this individual leg of a multileg security.
1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100
Applicable for BrokerTec markets only.
→1799 OrderEventPx PRICE9 8 Y Refers to the fill price; same as tag 31-LastPx →1802 OrderEventText String5 5 N Will not be present for BrokerTec US; Will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades →1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; It will be unique per instrument per day →1800 OrderEventQTY uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order →1796 OrderEventType OrderEventTye 1 Y - 4=Partially Filled
- 5=Filled
The type of event affecting an order →1798 OrderEventReason uInt8 1 Y Action that caused the event to occur. 100=Binary Trade Reporting -
Page:iLink 3 Order Mass Action Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
2422 OrderRequestID uInt64 8 Y Use OrderRequestID to identify a request to enter, modify, or delete an order. Echoed back on the Order Mass Action Report response.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y - Futures and options on futures markets: Represents Operator ID.
- Fixed income markets: Represents the Entering Trader.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576-Identification of Globex Terminal Operators and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
1373 MassActionType MassAction 0 Y - Cancel=3
Specifies the type of action requested.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 1151 SecurityGroup StringLength6 6 N Specifies the Product Group for which working orders should be cancelled. Conditionally required if MassActionScope=“Product Group” (tag 1374=10). Will be ignored if present for any MassActionScope other than Product Group.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
48 SecurityID Int32NULL 4 N Conditionally required if MassActionScope=”Instrument” (tag 1374=1). Will be ignored if present for any MassActionScope other than Instrument.
1374 MassActionScope MassActionScope 1 Y - 1=Instrument
- 7=All (for future use)
- 9=Market Segment ID
- 10=Product Group
- 100=Quote Set ID (for future use)
Specifies the scope of the action.
1300 MarketSegmentID uInt8NULL 1 N Specifies the market segment (physical match engine partition) for which working orders should be cancelled. Conditionally Required if MassActionScope=”Market Segment” (tag 1374=9). Will be ignored if present for any MassActionScope other than Market Segment.
6115 MassCancelRequestType MassCxlReqTyp 1 N MassCancelRequestType=100 (Operator ID)
MassCancelRequestType=101 (Account)
If present specifies the scope of the Order Mass Action Request within the context of Session and Firm. If absent all orders belonging to Session and Firm combination will be cancelled for specified MassActionScope.
54 Side SideNULL 1 N - Side=1 (Buy)
- Side=2 (Sell)
If present only orders belonging to one side will be cancelled.
If absent orders belonging to both sides will be cancelled.
40 OrdType MassActionOrdTyp 1 N - OrdType=2 (Limit)
- OrdType=4 (StopLimit)
If present then only orders of this type will be cancelled.
If absent then all order types will be cancelled.
59 TimeInForce MassCancelTIF 1 N - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=6 (GTD)
If present then only orders with this qualifier will be cancelled.
If absent then all Day & GT orders will be cancelled.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
-
Page:iLink 3 Order Mass Action Report (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For fixed income markets: represents the Entering Trader.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time.
UNDER DEVELOPMENT. Currently sent in milliseconds.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify an OrderMassActionRequest and echo the value on the corresponding OrderMassActionReport
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
1369 MassActionReportID uInt64 8 Y Unique ID of Order Mass Action Report as assigned by CME. If fragmented, then all messages must have the same value. 1373 MassActionType MassAction 0 Y - Cancel=3
Specifies the type of action requested.
Constant value.
1151 SecurityGroup StringLength6 6 N Specifies the Product Group for which working orders should be cancelled. Conditionally present if MassActionScope=“Product Group” (tag 1374=10).
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
48 SecurityID Int32NULL 4 N Conditionally present if MassActionScope=”Instrument” (tag 1374=1).
5904 DelayDuration uInt16NULL 2 N Not currently being used.
1375 MassActionResponse MassActionResponse 1 Y - 0=Rejected
- 1=Accepted
Specifies the action taken by CME when it received the Order Mass Action Request. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
1374 MassActionScope MassActionScope 1 Y - 1=Instrument
- 7=All
- 9=Market Segment ID
- 10=Product Group
- 100=Quote Set ID (for future use)
Specifies the scope of the action.
533 TotalAffectedOrders uInt8 1 Y Total number of orders affected by the Order Mass Action Request. Will be returned as zero for rejects or if no orders could be cancelled.
If fragmented, then this is the sum of NoAffectedOrders across all
messages with the same MassActionReportID.Otherwise will have same value as NoAffectedOrders when one or more orders is cancelled.
893 LastFragment BooleanFlag 1 Y - 0=Not Last Message
- 1=Last Message
Indicates whether the message is the last message in a sequence of messages to support fragmentation. 1376 MassActionRejectReason uInt8NULL 1 N Not currently being used. 1300 MarketSegmentID uInt8NULL 1 N Specifies the market segment (physical match engine partition) for which working orders should be cancelled. Conditionally present if MassActionScope=”Market Segment” (tag 1374=9)
6115 MassCancelRequestType MassCxlReqTyp 1 N MassCancelRequestType=100 (Operator ID)
MassCancelRequestType=101 (Account)
If present – specifies the scope of the Order Mass Action Request within the context of Session and Firm. If absent then all orders belonging to Session and Firm combination will be cancelled for specified MassActionScope.
54 Side SideNULL 1 N - Side=1 (Buy)
- Side=2 (Sell)
If provided then only orders belonging to one side will be cancelled. If absent then orders belonging to both sides will be cancelled.
40 OrdType MassActionOrdTyp 1 N - OrdType=2 (Limit)
- OrdType=4 (StopLimit)
If provided then only orders of this type will be cancelled. If absent then all order types will be cancelled.
59 TimeInForce MassCancelTIF 1 N - TimeInForce=0 (Day)
- TimeInForce=1 (GTC)
- TimeInForce=6 (GTD)
If provided then only orders with this qualifier will be cancelled. If absent then all Day & GT orders will be cancelled.
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
534 NoAffectedOrders groupSize 3 N Total number of order identifiers affected by the Order Mass Action Request. Only used if orders could actually be cancelled ,otherwise will be set to zero. Must be followed by OrigCIOrdID. →41 OrigCIOrdID String20Req 20 Y Contains the ClOrd of the cancelled order. →535 AffectedOrderID uInt64 8 Y Order ID of an order cancelled by a Mass Action Request. →84 CxlQuantity uInt32 4 Y Total quantity cancelled for this order. 7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
2807
CancelText
String8 8 N
Represents the SenderComp which initiates the cancellation of orders or quotes for the original SenderComp.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
-
Page:iLink 3 Quote Cancel (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
117 QuoteID uInt32 4 Y Client system generated identifier of the Quote Cancel message.
Must be unique per message trading session.
298 QuoteCancelType QuoteCxlTyp 1 Y - 1=Cancel for Instrument
- 3=Cancel for Security Group
- 4=Cancel All Quotes
- 100=Cancel for Quote Set
Identifies the type of Quote Cancel. Cancel can an be by instrument, quote set, product group, or all.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
9182
QuoteEntryOpen
BooleanNULL
1
N
A boolean value indicating whether or not new quotes should be rejected for the SenderComp for whom quotes are being cancelled; also used to reset such a block on Mass Quotes being sent by the blocked SenderComp.
295 NoQuoteEntries groupSize 3 Y - minValue=1
- maxValue=15
The number of quote entries for quote sets, instruments, product group, or cancel all.
298=1 → 1 to 15
298=3 → 1
298=4 → 1
298=100 → 1 (for cancel by quote set a product group has to be specified here)
→1151 SecurityGroup StringLength6 6 Y A designation assigned a group of related securities which may be concurrently affected by market events and actions.
Must be first field in the repeating group.
Should contain [N/A] for cancel all.
All quote sets and individual instruments must belong to a specific product group; the first determines the group to be applied for the rest of the repeating group entries.
→48 SecurityID Int32NULL 4 N Should be conditionally populated only for 298=1 (cancel for instrument).
Will be ignored if present for any QuoteCancelType other than Instrument.
296 NoQuoteSets groupSize 3 N - minValue=1
- maxValue=15
The number of sets of quotes in the message. Conditionally required if 298=100.
Set the groupSize to 0 when not required.
→134 BidSize uInt32NULL 4 N Should be conditionally populated and set to zero only for 298=100 (cancel for Quote Set) to cancel all buy side quotes for Quote Set ID.
Will be ignored if present for any QuoteCancelType other than Quote Set.
→135 OfferSize uInt32NULL 4 N Should be conditionally populated and set to zero only for 298=100 (cancel for Quote Set) to cancel all sell side quotes for Quote Set ID.
Will be ignored if present for any QuoteCancelType other than Quote Set.
→302 QuoteSetID uInt16 2 Y Should be conditionally populated only for 298=100 (cancel for Quote Set).
Will be ignored if present for any QuoteCancelType other than Quote Set.
Customers must assign an identifier between 1-999.
-
Page:iLink 3 Mass Quote Acknowledgment (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact, including preceding and following spaces.1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5979 RequestTime uIn64 8 Y Time (UTC) the request was received by the MSGW. UTC timestamps are sent in number of nanoseconds since the UNIX epoch with microsecond precision. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 131
QuoteReqID
uInt64NULL
8
N Conditionally present when Mass Quote was sent in response to Request for Quote. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
117 QuoteID uInt32 4 Y Unique identifier for Mass Quote populated by the client system. 300
QuoteRejectReason
uInt16NULL
2
N 1=Unknown symbol (security)
2=Exchange (Security) closed
3=Quote request exceeds limit
5=Unknown quote
6=Duplicate quote
7=Invalid bid/ask spread
8=Invalid price
9=Not authorized to quote security
98=Market maker protection*
99=Missing account number or 'other' reason*
*CME defined valueContains reason (error code) the corresponding Mass Quote message has been rejected. When this tag is returned, all quotes in the corresponding Mass Quote message are rejected. 5904 DelayDuration uInt16NULL 2 N Not currently being used.
297
QuoteStatus
QuoteAckStatus
1
Y - 0=Accepted
- 5=Rejected
Indicates acceptance or rejection of Mass Quote message. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9772 NoProcessedEntries uInt8 1 Y Number of quotes that have been accepted from the corresponding inbound message. 9773 MMProtectionReset BooleanFlag 1 Y - 0=False
- 1=True
Set to Y on the first Quote Acknowledgment sent after Market Maker Protection reset. 9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2)
If absent, the message was not delayed and was neither split nor received out of order.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.304 TotNoQuoteEntries uInt8NULL 1 N Total number of quotes for the quote set across all messages.
Populated only for enumerated rejects.
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
9182
QuoteEntryOpen
BooleanNULL
1
N
A boolean value indicating whether or not new quotes should be rejected for the SenderComp for whom quotes are being cancelled; also used to reset such a block on Mass Quotes being sent by the blocked SenderComp.
295 NoQuoteEntries groupSize 3 N The number of quote entries for a quote set.
Populated only for enumerated rejects.
→299 QuoteEntryID uInt32 4 Y Unique identifier for a quote. The QuoteEntryID stays with the quote as a static identifier even if the quote is updated. For fills this value is transposed into tag 11-ClOrdID. →48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. →302 QuoteSetID uInt16 2 Y Unique ID for the Quote Set.
Customers must assign an identifier between 1-999.
→368 QuoteEntryRejectReason uInt8 1 Y Reject codes Reason (error code) quote has been rejected. -
Page:iLink 3 Quote Cancel Acknowledgment (Electronic Platform Information Console) —
Tag
Field Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5979 RequestTime uIn64 8 Y Time (UTC) the request was received by the MSGW. UTC timestamps are sent in number of nanoseconds since the UNIX epoch with microsecond precision. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 9774 CancelledSymbol StringLength6 6 Y Security Group cancelled for a Quote Cancel acknowledgment. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
117
QuoteID
uInt32
4
Y Unique identifier for Quote Cancel message. 300
QuoteRejectReason
uInt16NULL
2
N 1=Unknown symbol (security)
2=Exchange (Security) closed
3=Quote request exceeds limit
5=Unknown quote
6=Duplicate quote
7=Invalid bid/ask spread
8=Invalid price
9=Not authorized to quote security
20=Too many rejects and cancel Product Code*
98=Market maker protection*
99=Missing account number or 'other' reason*
*CME defined valueContains reason (error code) the corresponding Request for Quote message has been rejected. 5904 DelayDuration uInt16NULL 2 N Not currently being used.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
297 QuoteStatus QuoteCxlStatus 1 Y - 1=Cancel per Instrument
- 3=Cancel for Security Group
- 4=Cancel All Quotes
- 5=Rejected
- 100=Cancel per Quote Set
Identifies the type of Quote Cancel. A working quote can be cancelled by providing either it's instrument, quote set, product group, or by cancelling all.
9772 NoProcessedEntries uInt32 1 Y Number of quotes that have been accepted from the corresponding inbound message. 9773 MMProtectionReset BooleanFlag 1 Y - 0=False
- 1=True
Set to '1' on the Quote Cancel Acknowledgment message sent after Market Maker Protection is triggered and all resting quotes are cancelled for that particular group (tag 297=3).
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9775 UnsolicitedCancelType CharNULL 1 N iLink 2 Tag 9775-UnsolicitedCancelTypes Table of Values Type of Quote Cancel generated by CME. Returned only for unsolicited quote cancels. 9553 SplitMsg SplitMsg N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
304 TotNoQuoteEntries uInt8NULL 1 N Total number of quotes for the quote set across all messages.
Will be populated only for enumerated rejects for Cancel by Instrument.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
295 NoQuoteEntries groupSize 3 Y The number of quote entries for a quote set.
Populated only for enumerated rejects for Cancel by Instrument.
→299 QuoteEntryID uInt32 4 Y Unique identifier for a quote. The QuoteEntryID stays with the quote as a static identifier even if the quote is updated. For fills, this value is transposed into client order ID (tag 11). →48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. →368 QuoteEntryRejectReason uInt8 1 Y Reject codes Reason (error code) quote has been rejected. 296 NoQuoteSets groupSize 3 N The number of sets of quotes in the message.
Will be populated only for enumerated rejects for Cancel by Quote Set.
→302 QuoteSetID uInt16 2 Y Unique ID for the Quote Set.
Customers must assign an identifier between 1-999
→9030 QuoteErrorCode uInt16 2 Y 1=Unknown symbol (Security)
2=Exchange (Security) closed
4=Too late to enter
6=Duplicate quote set ID (if CME Globex already processed this quote set ID in the same message)
9=Not authorized to quote security
Reason (error code) quote set cancel has been rejected. 7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
9937
OrigOrderUser
String8 8 N Represents the original SenderComp for whom orders or quotes are to be cancelled.
2807
CancelText
String8 8 N
Represents the SenderComp which initiates the cancellation of orders or quotes for the original SenderComp.
9182
QuoteEntryOpen
BooleanNULL
1
N
A boolean value indicating whether or not new quotes should be rejected for the SenderComp for whom quotes are being cancelled; also used to reset such a block on Mass Quotes being sent by the blocked SenderComp.
-
Page:iLink 3 Mass Quote (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
131 QuoteReqID uInt64NULL 8 N Unique identifier for quote request being responded to. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
117 QuoteID uInt32 4 Y Unique identifier for Mass Quote populated by the client system. 304 TotNoQuoteEntries uInt8 1 Y Total number of quotes for the quote set across all messages. Should be the sum of all NoQuoteEntries in each message that has repeating quotes that are part of the same quote set. Required if NoQuoteEntries > 0.
Since fragmentation is not supported, this will always be equal to the value of NoQuoteEntries.
9773 MMProtectionReset BooleanFlag 1 Y - 0=False
- 1=True
When Market Maker Protection is triggered, CME Globex will not accept any new quotes from the market maker for that product group until it receives a Mass Quote message with the MMProtectionReset flag set to True (1). 9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption SESH
- 2=Short Sale With Exemption SSEX
- 3=Undisclosed Sell Information Not Available UNDI
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.5187 Reserved String30 30 N Reserved for future use. 5239 Reserved1 String30 30 N Reserved for future use. 9182
QuoteEntryOpen
BooleanNULL
1
N
A boolean value indicating whether or not new quotes should be rejected for the SenderComp for whom quotes are being cancelled; also used to reset such a block on Mass Quotes being sent by the blocked SenderComp.
295 NoQuoteEntries groupSize 3 Y - minValue=1
- maxValue=15
The number of quote entries for a quote set. →132 BidPx PRICENULL9 8 N Bid price/rate accompanying bid size (tag 134). Note that either BidPx, OfferPx. or both must be specified for a new quote. →133 OfferPx PRICENULL9 8 N Offer price/rate. This goes together with offer size (tag 135). Note that either BidPx, OfferPx or both must be specified for a new quote. →299 QuoteEntryID uInt32 4 Y Unique identifier for a quote. The QuoteEntryID persists with the quote as a static identifier even if the quote is updated.
For fills, this value is transposed into the Client Order ID (tag 11).
For trade cancellation or correction resulting from quotes, this value is not transposed into the Client Order ID (tag 11).
→48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. →134 BidSize uInt32NULL 4 N Quantity of bid. This accompanies bid price (tag 132). →135 OfferSize uInt32NULL 4 N Quantity of offer. This accompanies offer price (tag 133). →309 UnderlyingSecurityID Int32NULL 4 N Description of the underlying futures security.
→302 QuoteSetID uInt16 2 Y Unique ID for the Quote Set. Customers must assign an identifier between 1-999. -
Page:Establishment Reject (Electronic Platform Information Console) —
Tag Field Name Binary Type Binary Length Req Enumeration Description 39011 Reason String48 48 N Reject reason details.
Only used for descriptive rejects.
39001 UUID uInt64 8 Y Matches Establish.UUID value.
39002 RequestTimestamp uInt64 8 Y Matches Establish.RequestTimestamp value. 39013 NextSeqNo uInt32 4 Y Next expected message sequence number.
On primary connection, the expected message sequence number of the next business message from CME to customer.
- At the beginning of the week this should be set to 1
- Should be set to last known message sequence number + 1 for Establish message sent midweek using same UUID as previous Establish message
- Should be set to 1 for Establish message sent midweek using different UUID from previous Establish message
On backup connection, this will be set to 0.
39012 ErrorCodes uInt16 2 Y Rejection codes:
0 - HMACNotAuthenticated: failed authentication because identity is not recognized
1 - HMACNotAvailable: HMAC component is not responding (5sec)
3 - InvalidTimestamp: Timestamp is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
4 - RequiredHMACSignatureMissing: empty bytes in HMACSignature field
5 - RequiredAccessKeyIDMissing: empty bytes in AccessKeyID field
6 - RequiredSessionMissing: empty bytes in Session field
7 - RequiredFirmMissing: empty bytes in Firm field
9 - RequiredRequestTimestampMissing: null value in RequestTimestamp field
10 - SessionBlocked: session and firm are not authorized for this port
11 - InvalidKeepAliveInterval: value is out of acceptable range (MIN, MAX)
12 – InvalidAccessKeyID: contains non-printable ASCII character
13 – InvalidSession: contains non-printable ASCII character
14 – InvalidFirm: contains non-printable ASCII character
15 - Volume Controls - exceeding TPS limit as defined for volume controls (reject action)
16 - SplitMessageRejected - Messages queued due to split message penalty being rejected because of logout or disconnect
17 - SplitMessageQueue - Reached threshold of messages queued due to split message penalty
18 - RequiredTradingSystemNameMissing: empty bytes in TradingSystemName
19 - RequiredTradingSystemVersionMissing: empty bytes in TradingSystemVersion
20 - RequiredTradingSystemVendorMissing: empty bytes in TradingSystemVendor
21 - RequiredKeepAliveIntervalMissing: null value in KeepAliveInterval field
23 - InvalidTradingSystemName: contains non-prinatable ASCII character
24 - InvalidTradingSystemVersion: contains non-prinatable ASCII character
25 - InvalidTradingSystemVendor: contains non-prinatable ASCII character
27 - DesignatedBackup - Using Designated backup before designated primary not allowed
39010 FaultToleranceIndicator FTI 1 Y 0 – Backup
1 – Primary
Indicates whether the connection is the primary or backup.
9553 SplitMsg uInt8NULL Enum 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates one of the following:
- 0 = a message was delayed as a result of being split among multiple packets (0)
- 1 = a message was delayed as a result of TCP re-transmission (1)
- 2 = a complete message was delayed due to a previously submitted split or out of order message (2).
If absent then the message was not delayed and was neither split nor received out of order.
-
Page:Negotiation Reject (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39011 Reason String48 48 N Reject reason details.
Only used for descriptive rejects.
39001 UUID uInt64 8 Y Matches Negotiate.UUID.
39002 RequestTimestamp uInt64 8 Y Matches Negotiate.RequestTimestamp. 39012 ErrorCodes uInt16 2 Y Rejection codes:
0 - HMACNotAuthenticated: failed authentication because identity is not recognized
1 - HMACNotAvailable: HMAC component is not responding (5sec)
3 - InvalidTimestamp: Timestamp is not greater than the one last used or value sent by the client is out of acceptable range (MIN, MAX)
4 - RequiredHMACSignatureMissing: empty bytes in HMACSignature field
5 - RequiredAccessKeyIDMissing: empty bytes in AccessKeyID field
6 - RequiredSessionMissing: empty bytes in Session field
7 - RequiredFirmMissing: empty bytes in Firm field
9 - RequiredRequestTimestampMissing: null value in RequestTimestamp field
10 - SessionBlocked: session and firm are not authorized for this port
12 – InvalidAccessKeyID: contains non-printable ASCII character
13 – InvalidSession: contains non-printable ASCII character
14 – InvalidFirm: contains non-printable ASCII character
15 - Volume Controls - exceeding TPS limit as defined for volume controls (reject action)
16 - SplitMessageRejected - Messages queued due to split message penalty being rejected because of logout or disconnect
17 - SplitMessageQueue - Reached threshold of messages queued due to split message penalty
27 - DesignatedBackup - Using Designated backup before designated primary not allowed
28 - NegotiateNotAllowed - Not allowed to negotiate on backup when established on primary
39010 FaultToleranceIndicator FTI 1 Y 0=Backup
1=Primary
Indicates whether the connection is primary or backup.
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
-
Page:iLink 3 Execution Report - Trade Spread Leg (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1188 Volatility Decimal64NULL 9 N Annualized volatility for option model calculations. Only applicable for vol quoted option trades
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill. 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
1190 RiskFreeRate Decimal32NULL 5 N Interest rate. Usually some form of short-term rate. 48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 14 CumQty uInt32 4 Y Total quantity filled. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatusTrd 1 Y - OrdStatus=1 (Partially Filled)
- OrdStatus=2 (Filled)
Identifies status of order as partially filled or completely filled. 150 ExecType ExecTypeTrade 0 Y ExecType=F (Trade)
Describes the specific Execution Report (e.g. Cancel) while tag 39-OrdStatus always identifies the current order status (e.g. Partially Filled).
Constant value.
40 OrdType OrderType 1 Y - OrdType=1 (Market order with protection)
- OrdType=2 (Limit order)
- OrdType=4 (Stop limit order)
- OrdType=K (Market limit order)
Order type. 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of spread leg trade. 9765 PossRetransFlag BooleanFlag 1 Y 0=False
1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
64 SettlDate LocalMktDate 2 N Specific date of trade settlement for the Spot leg 1056 CalculatedCcyLastQty Decimal64NULL 9 N Total amount traded (in notional) in counter currency for the Spot leg
381 GrossTradeAmt Decimal64NULL 9 N Total amount traded (in notional) in base currency for the Spot leg 1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report.
Maximum number of fill reasons is 6.
→1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills (1362) > 0. Same as LastPx (31) →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason. →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills (tag 1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation. →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
Enumeration of the Fill Reason field using Integer. This identifies the type of match algorithm. 1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100.
Applicable for BrokerTec markets only.
→1799 OrderEventPx PRICE9 8 Y Refers to the fill price; same as tag 31-LastPx →1802 OrderEventText String5 5 N Will not be present for BrokerTec US; Will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades →1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; It will be unique per instrument per day →1800 OrderEventQTY uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order →1796 OrderEventType OrderEventTye 1 Y - 4=Partially Filled
- 5=Filled
The type of event affecting an order →1798 OrderEventReason uInt8 1 Y Action that caused the event to occur. 100=Binary Trade Reporting -
Page:iLink 3 Business Reject (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
5392 SenderID String20 20 N For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
1505 PartyDetailsListReqID uInt64NULL 8 N The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 379 BusinessRejectRefID uInt64NULL 8 N Identifier of the rejected message as follows:
- Tag 2422 for New Order Single, Order Cancel Replace Request, Order Cancel Request, New Order Cross
- Tag 790 for Order Status Request
- Tag 2422 for Order Mass Action Request
- Tag 584 for Order Mass Status Request
- Tag 320 for Security Definition Request
- Tag 1505 for Party Details List Request
- Tag 1505 for Party Details Definition Request
- Tag 131 for Request for Quote
- Tag 117 for Mass Quote and Quote Cancel
Required unless the ID field is absent.
9537 Location String5 5 N ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
45 RefSeqNum uInt32NULL 4 N Tag 9726 - SeqNum of the rejected message.
Any business reject message with the following reject code will have tag 45-RefSeqNum = NULL.
3 – Unsupported Message Type
109 – Incoming message could not be decoded
Note: When the tag 45 value is NULL, this indicates CME Globex did not increment the message sequence number of the rejected business message and:
- The client system should not increment the message sequence number of the next business message to be sent
- If client system increments the message sequence number of the next business message to be sent, a Not Applied message will be sent to the customer to let them know that sequence number has not been applied by CME Globex.
371 RefTagID uInt16NULL 2 N The tag number of the invalid FIX/FIXP field. 380 BusinessRejectReason uInt16 2 Y Code to identify reason for a Business Message Reject message.
0 – Other
1 – Unknown ID (unknown PartyDetailsListReqID being referenced in business message)
2 – Unknown Security
3 – Unsupported Message Type (for example using messages specific to cash markets for futures)
5 – Required Field Missing
6 – Not Authorized
8 – Throttle Limit Exceeded (volume controls)
100 – Value is incorrect (out of range) for this tag (for example using a value outside defined range of integer)
101 – Incorrect data format for value (for example using ASCII character outside 32-126 in string field)
102 – Rejected due to Kill Switch
103 – Rejected due to Risk Management API
104 – Rejected due to Globex Credit Controls
105 – Not Authorized to trade Deliverable Swap Futures
106 – Not Authorized to trade Interest Rate Swap Futures
107 – Rejected due to Inline Credit Controls
108 – Invalid PartyDetailsListReqID (reusing already existing PartyDetailsListReqID while creating Party Details Definition Request)
109 – Incoming message could not be decoded
110 – Same repeating group entry appears more than once
111 – Exceeded maximum number of allowable Party Details Definition Requests
112 – Technical Error in Registering Party Details
113 – Rejected due to Cross Venue Risk
114 – Order Status Not Available
115 – Enum Not Supported
116 – Order Status Not Found
117 – Mass Order Status Cannot be Completed
118 – Exceeded Maximum Number of Allowable RequestingPartyID's in Party Details List Request
119 – Duplicate Order Threshold Exceeded
120 – On-Demand Message Rejected Due to Corresponding PartyDetailsDefinitionRequest Being Rejected
121 – Message Rejected Since PartyDetailsListReqID Does Not Match with Corresponding PartyDetailsDefinitionRequest as part of On-demand Message
122 – Party Details Definition Request sent to MSGW Being Rejected Due to Corresponding Business Message Being Rejected
123 – Another Message Sent in Between Party Details Definition Request and Business Message when using On-demand administrative information
124 – Cannot Have More Than One In-Flight Mass Order Status Request in Progress
125 – Exceeded Maximum Number of In-Flight Order Status Requests
126 – Cannot Have More Than One In-Flight Party Details List Request in Progress
127 – Party Details List Request is Missing Requesting Party ID and Party ID
128 – Party Details List Request cannot contain both RequestingPartyID and PartyID
129 – Party Details Definition Request Being Rejected Since Another Message was sent in Between On-Demand Message
130 – Buy Side Firm ID Does Not Match Sell Side Firm ID in New Order Cross
131 – Message Type Not Supported on Backup Instance
132 – New Order Cross Does Not Contain Buy Side Followed by Sell Side
133 – Duplicate ClOrdID: X not allowed
134 – Value Provided Does Not Match With Original Trade (EU Bilateral Reject)
135 – Combination of Order ID & SecExecID not found (EU Bilateral Reject)
136 – Non Zero Limit Price Not Allowed for eFix Instruments
137 – Messages queued due to latency floor being rejected because of session terminate or disconnect prior to release from latency floor
138 – Message rejected due to internal technical error
139 – Max Order Size Exceeded
140 – Not Authorized to Submit GFS Orders (Only FAK/FOK Allowed)
141 - Invalid On-Behalf Information if less than 6 characters (i.e. invalid tag 9937-OrigOrderUser)
142 - Invalid On-Behalf Information if both sender comp ID's are the same value (i.e. tag 9937-OrigOrderUser cannot be same as sending session and firm)
143 - Invalid On-Behalf Information if both GFID's are different (i.e. GFID does not match between tag 9937- OrigOrderUser and PartyDetailRole=1)
144 - Quotes cannot be blocked for instrument or quote set on-behalf
145 - Quote rejected: Blocked from quoting this instrument 'cannot quote group: xx'
146 - Cancel On Behalf feature not available
147 - Not Authorized to cancel for OrigOrderUser: xxxxxx
148 - CancelOnBehalf not allowed on iLink2 order or quote
372 RefMsgType String2 2 N The MsgType of the FIX message being referenced.
D – New Order Single
G – Order Cancel Replace Request
F – Order Cancel Request
i – Mass Quote
Z – Quote Cancel
H – Order Status Request
CA – Order Mass Action Request
AF – Order Mass Status Request
s – New Order Cross
R – Request for Quote
c – Security Definition Request
CX – Party Details Definition Request
CF – Party Details List Request
SQ – Sequence
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
1028 ManualOrderIndicator ManualOrdInd
1 N - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
-
Page:Not Applied (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
39001 UUID uInt64 4 Y Matches Establish.UUID.
39018 FromSeqNo uInt32 4 Y First not applied sequence number.
39019 MsgCount uInt32 2 Y Count of how many messages have not been applied.
This is the difference between:
the sequence number (tag 9726-SeqNum) of the last business message received OR the last next sequence number (tag 39013-NextSeqNo) in the Establish message from the customer (inclusive)
AND
the sequence number (tag 9726-SeqNum) of the new business message received OR the new next sequence number (tag 39013-NextSeqNo) in the Establish message from the customer (inclusive)
Example
Last Message
New Message
Tag 39019-MsgCount in Not Applied Message
1
business message (tag 9726-SeqNum=100)
business message (tag 9726-SeqNum=110)
10
2
Establish message (tag 39013-NextSeqNo=100)
business message (tag 9726-SeqNum=110)
11
3
business message (tag 9726-SeqNum=100)
Establish message (tag 39013-NextSeqNo=110)
10
4
Establish message (tag 39013-NextSeqNo= 100)
Establish message (tag 39013-NextSeqNo= 110)
11
Although the Establish message does not have its own sequence number, the tag 39013-NextSeqNo value sent in the Establish message is used to calculate the number of messages that have not been applied.9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order
-
Page:iLink 3 Order Cancel Replace Reject (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects
17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
Will be set to 0 if in response to OrderCancelReplaceRequest using ClOrdID.
60 TransactTime uInt64 8 Y Time the transaction represented by this Order Cancel Replace Reject (35=9) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
102 CxlRejReason uInt16 2 Y Code to identify reason for order rejection.
See BrokerTec Reject Codes for BrokerTec Markets.
See EBS Reject Codes for EBS Market
5904 DelayDuration uInt16NULL 2 N Not currently being used.
39 OrdStatus OrdStatusCxrRej 0 Y - OrdStatus=U (Undefined)
Identifies status of modification reject.
Constant value.
434 CxlRejResponseTo CxrRejRsp 0 Y - 2=OrderCancelReplaceRequest
Identifies the type of request that a Cancel Reject is in response to.
Constant value.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually. 9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
-
Page:iLink 3 Order Cancel Reject (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
39 OrdStatus OrdStatusCxlRej 0 Y - OrdStatus=U (Undefined)
Identifies status of modification reject.
Constant value.
434 CxlRejResponseTo CxlRejRsp 0 Y - 1=OrderCancelRequest
Identifies the type of request that a Cancel Reject is in response to.
Constant value.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
Will be set to 0 if in response to OrderCancelRequest using ClOrdID
60 TransactTime uInt64 8 Y Time the transaction represented by this Order Cancel Reject (35=9) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 2422 OrderRequestID uInt64 8 Y OrderRequestID used to identify a request to enter, modify, or delete an order. Echoed back on the Execution Report.
For the unsolicited events (e.g. fills and end of day eliminations), echo the value on the ExecutionReport representing the last accepted OrderRequestID on the corresponding order.
9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
102 CxlRejReason uInt16 2 Y Code to identify reason for order rejection.
See BrokerTec Reject Codes for BrokerTec Markets.
See EBS Reject Codes for EBS Market.
5904 DelayDuration uInt16NULL 2 N Not currently being used.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent, the message was not delayed and was neither split nor received out of order.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec and EBS MiFID.
7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
-
Page:iLink 3 Execution Acknowledgment (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
1036 ExecAckStatus Int 1 Y 1=Accepted
2=RejectedIndicates status of the Execution Acknowledgment. 9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages. This tag must be populated with the tag 1797-OrderEventExecID value from the iLink 3 Execution Report - Trade (35=8, 39=1,2) message.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
31 LastPx
PRICE9
8
Y Price of this (last) fill. This tag must be populated with the tag 1799-OrderEventPx value from the iLink 3 Execution Report - Trade (35=8, 39=1,2) message 48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. This tag must be populated with the tag 1800-OrderEventQty value from the iLink 3 Execution Report - Trade (35=8, 39=1,2) message. 127 DKReason Char 1 N - A=Unknown Security
- B=Wrong Side
- C=Qty Exceeds Order
- D=No Matching Order
- E=Price Exceeds Limit
- F=Calculation Difference
- G=No Matching Execution Report
- Z=Other
Reason for execution rejection 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
-
Page:iLink 3 Order Status Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
790 OrdStatusReqID uInt64 8 Y Used to uniquely identify a specific Order Status Request message. Echoed back on Execution Report. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
-
Page:iLink 3 Execution Report - Trade Addendum Spread (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill. 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nano seconds since midnight January 1, 1970. 527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
9703 OrigSecondaryExecutionID uInt64NULL 8 N Unique identifier of the corrected fill. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 37711 MDTradeEntryID uInt32 4 Y Market Data Trade Entry ID. This identifier is assigned to all trades that take place for an instrument at a particular price level. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 1507 OrigSideTradeID uInt32NULL 4 N Refers back to the unique ID assigned to the corrected trade.
75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatustrdCxl 1 Y - OrdStatus=H (Trade Cancel)
- OrdStatus=G (Trade Correction)
Identifies status of order as trade cancellation or correction.
150 ExecType ExecTypTrdCxl 1 Y - ExecType=H (Trade Cancel)
- ExecType=G (Trade Correction)
Describes the specific Execution Report as trade cancellation or correction.
40 OrdType OrderType 1 N - OrdType=2 (Limit order)
UNDER DEVELOPMENT 54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if order was sent manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
393 TotalNumSecurities uInt8NULL 1 Y Indicates total number of leg fills for the spread.
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTecParty Details List RequestID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report.
Specifies the number of fill reasons included in this Execution Report.
Maximum number of fill reasons is 6.
Note: The number of fill reason is always '1' for spread leg fills.
→1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills (tag 1362) > 0. Same as tag 31-LastPx. →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason. →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills (tag 1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation. →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
Enumeration of the Fill Reason field using Integer. This identifies the type of match algorithm. 555 NoLegs groupSize 3 N Number of leg executions. Set to '0'.
→1893 LegExecID uInt64 8 Y The tag 17-ExecID value corresponding to a trade leg. →637 LegLastPx PRICE9 8 Y Execution price assigned to a leg of a multileg instrument →1901 LegExecRefID uInt64NULL 8 N The original tag ExecID value corresponding to corrected trade leg. →1894 LegTradeID uInt32 4 Y The TradeID value corresponding to a trade leg →39023 LegTradeRefID uInt32NULL 4 N Refers to the original LegTradeID of the leg trade being corrected →602 LegSecurityID Int32 4 Y Leg SecurityID →1418 LegLastQty uInt32 4 Y Fill quantity for the leg instrument. →624 LegSide SideReq 1 Y The side of this individual leg of a multileg security.
1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100.
Applicable for BrokerTec markets only.
→1799 OrderEventPx PRICE9 8 Y For Trade Cancel, refers to price of the canceled trade.
For Trade Correction, refers to the new fill price.
→1802 OrderEventText String5 5 N Not present for BrokerTec US; will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades. →1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; it will be unique per instrument per day. →1800 OrderEventQty uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order. →1796 OrderEventType TradeAddendum 1 Y - 100=Trade Cancel
- 101=Trade Correction
- 4=Partially Filled
- 5=Filled
The type of event affecting an order. →1798 OrderEventReason uInt8 1 Y - 100=Binary Trade Reporting
Action that caused the event to occur. →6555 OriginalOrderEventExecID uInt32NULL $ N Contains the previous tag 1797-OrderEventExecID value of the trade being adjusted or busted. -
Page:iLink 3 Execution Report - Trade Addendum Outright (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill. 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
9703 OrigSecondaryExecutionID uInt64NULL 8 N Unique identifier of the corrected fill. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 1507 OrigSideTradeID uInt32NULL 4 N Refers to the unique ID assigned to the corrected trade. 75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatusTrdCxl 1 Y - OrdStatus=H (Trade Cancel)
- OrdStatus=G (Trade Correction)
Identifies status of order as trade cancellation or correction.
150 ExecType ExecTypTrdCxl 1 Y - ExecType=H (Trade Cancel)
- ExecType=G (Trade Correction)
Describes the specific Execution Report as trade cancellation or correction.
54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Order side. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
18 ExecInst ExecInst 1 N - Bit 0=AON
- Bit 1=Only Best
- Bit 2=Not Held
Instructions for order handling for fixed income markets.
Only Best may be applied to resting and aggressing orders and:
- Prevents submission of an order if the order’s price is not equal to or better than the best price on the book.
- Cancels an order from the book if a new order with a better price enters the queue.
- This order condition permits the order to be alone at the best price level or join other orders at the best price level.
Not Held (applies only to US Repo) eliminates quantity remaining from an FaKi order (tag 59=3) and ensures it will it not be included in a work-up session; however, the order can still trigger a work-up session.
AONs will have a separate book with a separate ISIN. The AON orders that cannot trade immediately can rest in the AON book. They can only trade with AON orders on the other side of the AON book that have the SAME PRICE and SAME QUANTITY.
Applicable only for BrokerTec Markets; should not be used for future and options markets.
5906 ExecutionMode ExecMode 1 N - A=Aggressive
- P=Passive
Instruction for whether the order should rest on the book upon entry or match as an aggressor.
A Passive Order will rest in the market without executing unless matched with an Aggressive Order on the other side.
An Aggressive Order will match against any other order on the opposite side.
Applicable for US & EU Repos.
9373 LiquidityFlag BooleanNULL 1 N - 0=False
- 1=True
Indicates if an order was submitted for market making obligation as required for MIFID.
Applicable only for EU BrokerTec MiFID.
6881 ManagedOrder BooleanNULL 1 N - 0=False
- 1=True
Boolean: flags a managed order.
Applicable only to Repo fixed income markets.
5409 ShortSaleType ShortSaleType 1 N - 0=Long Sell
- 1=Short Sale With No Exemption (SESH)
- 2=Short Sale With Exemption (SSEX)
- 3=Undisclosed Sell (Information not available – UNDI)
Indicates the type of short sale on Sell orders only as required for MiFID.
Should not be used for Buy orders.
Applicable only for EU fixed income markets.
Note
The Short-Selling Field is only required from Participants when BrokerTec EU has a regulatory obligation (pursuant to Article 26(5) of MiFIR) to conduct transaction reporting on behalf of the Participant. This obligation only applies to BrokerTec EU when the relevant participant is exempt from MiFIR (typically non-EEA (European Economic Area) firms, corporate entities or certain asset managers). Please reach out to TradingVenueCompliance@cmegroup.com for guidance.1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report.
Maximum number of fill reasons is 6.
→1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills(1362) > 0. Same as LastPx(31) →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills(1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
Enumeration of the Fill Reason field using Integer. This identifies the type of match algorithm 1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100
Applicable for BrokerTec markets only.
→1799 OrderEventPx PRICE9 8 Y Refers to the fill price; same as tag 31-LastPx →1802 OrderEventText String5 5 N Will not be present for BrokerTec US; Will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades →1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; It will be unique per instrument per day →1800 OrderEventQty uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order. →1796 OrderEventType TradeAddendum 1 Y - 100=Trade Cancel
- 101=Trade Correction
- 4=Partially Filled
- 5=Filled
The type of event affecting an order. →1798 OrderEventReason uInt8 1 Y - 100=Binary Trade Reporting
Action that caused the event to occur. →6555 OriginalOrderEventExecID uInt32NULL $ N Contains the previous tag 1797-OrderEventExecID value of the trade being adjusted or busted.
Will not be present on the following message types
- Execution Report Trade Outright
- Execution Report Trade Spread
- Execution Report Trade Spread Leg
-
Page:iLink 3 Execution Report - Trade Addendum Spread Leg (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 17 ExecID String40 40 Y Globally unique identifier for each Execution Report message assigned by exchange.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by client system. Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days.
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
31
LastPx
PRICE9
8
Y Price of this (last) fill. 37 OrderID uInt64 8 Y Globally unique identifier for each order assigned by the exchange.
60 TransactTime uInt64 8 Y Time the transaction represented by this Execution Report (35=8) occurred. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 527 SecExecID uInt64 8 Y Unique identifier linking spread summary fill notice with leg fill notice and trade cancel messages.
To uniquely identify each fill, Client System can concatenate: OrderID (37) + TradeDate (75) + SecExecID (527)
9703 OrigSecondaryExecutionID uInt64NULL 8 N Unique identifier of the corrected fill. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. 32 LastQty uInt32 4 Y Quantity bought/sold on this (last) fill. 1506 SideTradeID uInt32 4 Y The unique ID assigned to the trade once it is received or matched by the exchange. 1507 OrigSideTradeID uInt32NULL 4 N Refers to the unique ID assigned to the corrected trade. 75 TradeDate LocalMktDate 2 Y Indicates date of trading day (expressed in local time at place of trade).
Sent in number of days since Unix epoch.
39 OrdStatus OrdStatusTrdCxl 1 Y - OrdStatus=H (Trade Cancel)
- OrdStatus=G (Trade Correction)
Identifies status of order as trade cancellation or correction.
150 ExecType ExecTypTrdCxl 1 Y - ExecType=H (Trade Cancel)
- ExecType=G (Trade Correction)
Describes the specific Execution Report as trade cancellation or correction.
1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9765 PossRetransFlag BooleanFlag 1 Y - 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of Trade Addendum Spread Leg. 64 SettlDate LocalMktDate 2 N Specific date of trade settlement for the Spot leg 1056 CalculatedCcyLastQty Decimal64NULL 9 N Total amount traded (in notional) in counter currency for the Spot leg
381 GrossTradeAmt Decimal64NULL 9 N Total amount traded (in notional) in base currency for the Spot leg 1362 NoFills groupSize 3 Y Specifies the number of fill reasons included in this Execution Report.
Maximum number of fill reasons is 6.
→1364 FillPx PRICE9 8 Y Price of this fill reason or allocation. Required if NoFills (1362) > 0. Same as LastPx (31) →1365 FillQty uInt32 4 Y Quantity bought/sold for this fill reason. →1363 FillExecID String2 2 Y Used as an identifier for each fill reason or allocation reported in single Execution Report. Required if NoFills (tag 1362) > 0. Append FillExecID with ExecID to derive unique identifier for each fill reason or allocation. →1622 FillYieldType uInt8 1 Y 0 – Future Hedge
1 – Pro Rata
2 – LMM
3 – TOP
4 – FIFO
5 – Cross BMG
8 – Covering
9 – Cross BPM
10 – Leveling
11 – Aggressor
14 – Leg
16 – Opening
18 – Implied Opening
19 – FIFO Percent
Enumeration of the Fill Reason field using Integer. This identifies the type of match algorithm. 1795 NoOrderEvents groupSize 3 N Number of fills which comprise fill quantity.
The maximum number of fills is configured 100.
Applicable for BrokerTec markets only.
→1799 OrderEventPx PRICE9 8 Y For Trade Cancel, refers to price of the canceled trade.
For Trade Correction, refers to the new fill price.
→1802 OrderEventText String5 5 N Will not be present for BrokerTec US; will be populated with the firm ID of the opposite order for BrokerTec EU bilateral trades. →1797 OrderEventExecID uInt32 4 Y This is a unique ID which ties together a specific fill between two orders; unique per instrument per day. →1800 OrderEventQty uInt32 4 Y Refers to the specific fill quantity between this order and the opposite order. →1796 OrderEventType TradeAddendum 1 Y - 100=Trade Cancel
- 101=Trade Correction
- 4=Partially Filled
- 5=Filled
The type of event affecting an order. →1798 OrderEventReason uInt8 1 Y - 100=Binary Trade Reporting
Action that caused the event to occur. →6555 OriginalOrderEventExecID uInt32NULL $ N Contains the previous tag 1797-OrderEventExecID value of the trade being adjusted or busted.
Will not be present on the following message types
- ExecutionReportTradeOutright
- ExecutionReportTradeSpread
- ExecutionReportTradeSpreadLeg
-
Page:iLink 3 Request for Quote Acknowledgment (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection. 58 Text String256 256 N Reject reason details.
Used only for descriptive rejects.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
9770
ExchangeQuoteReqID
String17
17
Y CME Globex generated QuoteID. 1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
5979 RequestTime uIn64 8 Y Time (UTC) the request was received by the MSGW. UTC timestamps are sent in number of nanoseconds since the UNIX epoch with microsecond precision. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 131
QuoteReqID
uInt64
8
Y Unique identifier for Quote Request message. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
300
QuoteRejectReason
uInt16NULL
2
N 1=Unknown symbol (security)
2=Exchange (Security) closed
3=Quote request exceeds limit
5=Unknown quote
6=Duplicate quote
7=Invalid bid/ask spread
8=Invalid price
9=Not authorized to quote security
20=Too many rejects and cancel Product Code*
98=Market maker protection*
99=Missing account number or 'other' reason*
*CME defined valueContains reason (error code) the corresponding Request for Quote message has been rejected. 5904 DelayDuration uInt16NULL 2 N Not currently being used.
297
QuoteStatus
QuoteAckStatus
1
Y - 0=Accepted
- 5=Rejected
Indicates acceptance or rejection. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y 0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9553 SplitMsg SplitMsg 1 N - 0=Split Msg Delayed
- 1=Out of Order Msg Delayed
- 2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
9765 PossRetransFlag
BooleanFlag
1
Y
- 0=False
- 1=True
Flags message as possible retransmission or duplicate
Indicates if message is an original transmission or duplicate in response to Retransmission Request or possible duplicate
Used when original messages are interleaved with Retransmission responses
Possible duplicate means the same message may have been sent again with different sequence number
7552 DelayToTime uInt64NULL 8 N Indicates the amount of time in nanoseconds that a message was subject to additional processing as a result of being:
- split among multiple packets (tag 9553=0)
- out-of-order (tag 9553=1)
- a previously submitted split message (tag 9553=2)
Subtracting this number from tag 60-TransactTime will represent original received time of in-flight message.
-
Page:iLink 3 Request for Quote (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Unique ID from Party Details Definition Request Acknowledgment message
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
131 QuoteReqID uInt64 8 Y Unique identifier for Quote Request. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y - 0=Automated
- 1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
537 QuoteType QuoteTyp 1 N - 1=Tradeable
Identifies the type of quote. 146 NoRelatedSym groupSize 3 Y - minValue=1
- maxValue=1
Specifies the number of repeating symbols.
→48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message. →38 OrderQty uInt32NULL 4 N Order quantity. Mandatory for buy or sell but not required for cross. →54 Side RFQSide 1 N - Side=1 (Buy)
- Side=2 (Sell)
- Side=8 (Cross)
For buy, sell, or cross RFQ, send tag 54. -
Page:iLink 3 New Order Cross (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
548 CrossID uInt64 8 Y Identifier for a cross order. Must be unique during a given trading day. 2422 OrderRequestID uInt64 8 Y Use OrderRequestID to identify a request to enter a cross order. Echoed back on the Execution Report. 1028 ManualOrderIndicator ManualOrdIndReq 1 Y
0=Automated
1=Manual
Indicates if the message was initially received manually.
'0' indicates the message was generated by automated trading logic.
iLink messages containing a value other than '0' or '1' in this tag will be rejected.
This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems.
https://www.cmegroup.com/rulebook/files/cme-group-Rule-536-B-Tag1028.pdf
9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
5392 SenderID String20Req 20 Y For futures and options markets: represents Operator ID.
For EBS and fixed income markets: represents the Entering Trader. For EBS this value must be 3 characters.
This value represents the individual or team submitting the message and is subject to registration requirements and character limits as required by Rule 576 and the Advisory below:
https://www.cmegroup.com/rulebook/files/cme-group-Rule-576.pdf
In FirmSoft and Global Command Center queries for order status and cancellations, this value must be exact.40 OrdType CrossOrdType 0 Y - OrdType=2 (Limit order)
Only ‘2’ (limit order) supported.
Constant value.
549 CrossType CrossType 0 Y - CrossType=3
A cross order which is executed on one side with any unfilled quantity remaining active.
Constant value.
550 CrossPrioritization CrossPrioritization 0 Y - CrossPrioritization=0 (None)
Indicates if one side of the cross order should be prioritized.
Constant value.
44 Price PRICE9 8 Y Conditionally required when tag 40-OrdType=2 (Limit). 483 TransBkdTime uInt64 8 Y For derivatives, a timestamp to indicate when this order was booked with the agent prior to submission to the exchange. Indicates the time at which the order was finalized between the buyer and seller prior to submission. Expressed as nanoseconds since epoch time. 5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 9537 Location String5Req 5 Y ISO identifier of the physical location of the individual or team head trader identified by the tag 5392 (SenderID) in the message.
The first two bytes as per ISO 3166-1, identify the country (e.g., JP = Japan, CN = China).
The next three bytes indicate a comma-delimited state or province code (e.g., CA = California, QC = Quebec).
For valid values, refer to ftp.cmegroup.com/fix/coo.
Market Regulation requires only the submission of the two first characters of tag 9537-Location for all countries with the exception of Canada. For Canada, the 5 bytes including the province code must be submitted.
Note: this field is optional for EBS Market and eFIX Matching Service instruments.
48 SecurityID Int32 4 Y Security ID as defined in the market data Security Definition message.
552 NoSides groupSize 3 Y - minValue=2
- maxValue=2
Number of Side repeating group instances.
2=Both Sides
→11 CIOrdID String20Req 20 Y Unique identifier for Order as assigned by the buy side (institution, broker, intermediary, etc.). Uniqueness must be guaranteed within a single trading day.
Firms, particularly those which electronically submit multi-day orders, trade globally, or throughout market close periods, should ensure uniqueness across days; for example, by embedding a date within the ClOrdID field.
→1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details Definition Request Acknowledgment associated with this message; this is the value submitted on the inbound message.
For pre-registered messages:
- Party Details Definition Request Ack message would have been sent beforehand and that unique ID should be provided here
- PartyDetailsListRequestID≠0.
For on-demand messages:
- If not registered beforehand through iLink then Party Details Definition Request Ack message will be sent along with the business message and will immediately precede it
- PartyDetailsListRequestID=0.
→38 OrderQty uInt32 4 Y Order quantity. Must be the same for both sides.
→54 Side SideReq 1 Y - Side=1 (Buy)
- Side=2 (Sell)
Side of order. →962 SideTimeInForce SideTimeInForce 1 Y - SideTimeInForce=0 (Day)
- SideTimeInForce=3 (FAK)
Indicates how long the order as specified in the side stays in effect. SideTimeInForce allows a two-sided cross order to specify order behavior separately for each side. -
Page:Establishment Acknowledgment (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39001 UUID uInt64 8 Y Matches Establish.UUID.
39002 RequestTimestamp uInt64 8 Y Matches Establish.RequestTimestamp. 39013 NextSeqNo uInt32 4 Y Next expected message sequence number.
On primary connection, the expected message sequence number of the next business message from CME to customer.
- At the beginning of the week this should be set to 1
- Should be set to last known message sequence number + 1 for Establish message sent midweek using same UUID as previous Establish message
- Should be set to 1 for Establish message sent midweek using different UUID from previous Establish message
On backup connection, this will be set to 0.
39021 PreviousSeqNo uInt32 4 Y Reflects the sequence number of the last business message published by CME with the PreviousUUID.
If no business message was published, this will be zero.
39015 PreviousUUID uInt64 8 Y Refers to the UUID sent in the previous message before this message from CME.
- This can be the CME assigned default UUID=0 for messages published by CME before first Negotiation of customer at the beginning of the week
- This can be the last UUID as used by the customer from the previously Established session
- If no business message has been published by CME, this will also be set to 0
39014 KeepAliveInterval uInt16 2 Y The longest time in milliseconds that CME will wait before sending a keep alive Sequence message.
CME Globex will echo back the keep-alive interval submitted in the customer Establish message.
39022 SecretKeySecureIDExpiration uInt16NULL 2 N Indicates the expiration date of the HMAC secret key. Sent in number of days since Unix epoch. 39010 FaultToleranceIndicator FTI 1 Y 0 – Backup
1 – Primary
Indicates whether the connection is the primary or backup.
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
-
Page:Negotiation Response (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39009 ServerFlow ExchFlowTyp 0 Y Recoverable Constant value representing type of flow from CME to customer. 39001 UUID uInt64 8 Y Matches Negotiate.UUID.
39002 RequestTimestamp uInt64 8 Y Matches Negotiate.RequestTimestamp. 39022 SecretKeySecureIDExpiration uInt16NULL 2 N Indicates the expiration date of the HMAC secret key. Sent in number of days since Unix epoch. 39010 FaultToleranceIndicator FTI 1 Y 0=Backup
1=Primary
Indicates whether the connection is the primary or backup.
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
39021 PreviousSeqNo uInt32 4 Y Refers to the SeqNum sent in the previous message before this one from CME. 39015 PreviousUUID uInt64 8 Y Refers to the UUID sent in the previous message before this one from CME. 39008 Credentials DATA 0 N Currently not supported; however the length of variable data needs to be set to 0, represented as two bytes 00 00.
-
Page:Retransmit Request (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39001 UUID uInt64 8 Y Matches Establish.UUID.
39017 LastUUID uInt64NULL 8 N If the Retransmit Request is for a previous UUID, then put that here otherwise put default null value.
0 – Default CME assigned UUID for any messages to be sent to customer before first customer Establish of the week.
Or
UUID from any previous Establish in the current week (Sunday-Friday)
Max value is 9223372036854775807
39002 RequestTimestamp uInt64 8 Y Time of request. CME Group recommends using the number of nanoseconds since epoch (Jan 1, 1970) as the timestamp. 39018 FromSeqNo uInt32 4 Y Sequence number of the first business message requested.
Tag 39018 will not be zero, but it contains the starting sequence number either for current UUID, previous UUID or the default UUID of 0.
39019 MsgCount uInt16 2 Y Number of business messages requested.
Cannot exceed 2500 at a time or the message will be rejected.
0 – Up to 2500 messages subsequent to FromSeqNo, when available. If the missing messages exceed 2500, it will be capped such that the request does not exceed total of 2500.
-
Page:Terminate (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39011 Reason String48 48 N Terminate reason details.
Will only be used for descriptive scenarios.
39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection.
39002 RequestTimestamp uInt64 8 Y Time of request; CME Group recommends using the number of nanoseconds since UNIX epoch (Jan 1, 1970) as the timestamp.
Outgoing response will match incoming Terminate.RequestTimestamp if sent in response to Terminate.
If sent in response to an incoming message, it will have the same RequestTimestamp from that message.
If sent unsolicited for auto port closure or volume controls (logout action), it will be set to the current system time.
39012 ErrorCodes uInt16 2 Y 0 - Finished: session is being terminated without finalization
2 - Unnegotiated: Sending any message when session has not been Negotiated
3 - NotEstablished: Sending any message (except Negotiate) when session has not been established
4 - AlreadyNegotiated: NegotiationResponse was already sent; Negotiate was redundant
5 - NegotiationInProgress: Previous Negotiate still being processed; Wait for NegotiationResponse or timeout
6 - AlreadyEstablished: EstablishmentAck was already sent; Establish was redundant
7 - EstablishInProgress: Previous Establish still being processed; Wait for EstablishmentAck or timeout
8 - CMEAdministeredPortClosure: due to invalid number of Negotiate/Establish attempts being exceeded
9 - Volume Controls - exceeding TPS limit as defined for volume controls (logout action)
10 - InvalidNextSeqNo - value is not greater than the one last used for same UUID or value sent by the client is out of acceptable range (MIN, MAX)
11 - InvalidMsgSeqNo - value is lower than the last one used for the same UUID or value is not initialized to 1 at the beginning of the week or value sent by the client is out of acceptable range (MIN, MAX)
12 - InvalidLastSeqNo - value is lower than the last one used for the same UUID or value sent by the client is out of acceptable range (MIN, MAX)
13 - InvalidUUID: UUID value does not match current UUID or value sent by the client is out of acceptable range (MIN, MAX)
14 - InvalidTimestamp: Timestamp value does not match with RequestTimestamp sent by CME or value sent by the client is out of acceptable range (MIN, MAX)
15 - RequiredUUIDMisssing: null value in UUID field
16 - RequiredRequestTimestampMissing: null value in RequestTimestamp field
17 - RequiredCodeMisssing: null value in Code field
18 - InvalidSOFH: Invalid message length or invalid encoding type specified
19 - DecodingError: Incoming message could not be decoded
20 - KeepAliveIntervalLapsed: KeepAliveInterval has lapsed without any response so terminating session
21 – RequiredNextSeqNoMissing: null value in NextSeqNo field
22-RequiredKeepAliveIntervalLapsedMissing: null value in KeepAliveIntervalLapsed field
23 - Non-Negotiate/Establish message received when not Negotiated/Established
24 - TerminateInProgress: Previous Terminate still being processed; Wait for Terminate or timeout
25 - Other: any other error condition not mentioned above
26 - DisconnectFromPrimary: Backup session will be terminated as well
27 - TerminatedFromPrimary: Backup session will be terminated as well
28 - RejectSplitMsgsQueued: Messages queued due to split message penalty being rejected because of terminate or disconnect
29 - ExceededMaxNoOfSplitMsgsQueued: Reached threshold of messages queued due to split message penalty
Termination code.
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
-
Page:Retransmission (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39001 UUID uInt64 8 Y Matches RetransmitRequest.UUID.
39017 LastUUID uInt64NULL 8 N Matches RetransmitRequest.LastUUID.
39002 RequestTimestamp uInt64 8 Y Matches RetransmitRequest.RequestTimestamp. 39018 FromSeqNo uInt32 4 Y Matches RetransmitRequest.FromSeqNo. 39019 MsgCount uInt16 2 Y For a previous UUID,
- matches RetransmitRequest.MsgCount if MsgCount >0
- returns 2500 if RetransmitRequest.MsgCount = 0
For a current UUID, returns count of messages to be replayed.
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
-
Page:iLink 3 Party Details List Request (Electronic Platform Information Console) —
Tag
Name
Binary Type
Binary Length
Req
Enumeration
Description
1505 PartyDetailsListReqID uInt64 8 Y The unique identifier of the Party Details List Request (35=CF) message.
5297 SendingTimeEpoch uInt64 8 Y Time when the message is sent. 64-bit integer expressing the number of nanoseconds since midnight January 1, 1970. 9726 SeqNum uInt32 4 Y Sequence number assigned to this message.
The max value is 999999999 which is 1 short of 1 billion.
1657 NoRequestingPartyIDs groupSize 3 N minValue=0
maxValue=1
Number of requesting party identifiers.
Will be zero if specific PartyDetailsDefinitionIDs are being requested.
Will be populated only if all PartyDetailsDefinitions are requested for a specific Firm.
→1658 RequestingPartyID String 5 Y Party identifier for the requesting party. Required when NoRequestingPartyIDs (tag 1657) > 0. →1659 RequestingPartyIDSource Char 1 Y Always “C” – Generally accepted market participant identifier Identifies the source of the RequestingPartyID(1658) value. Required when NoRequestingPartyIDs (tag 1657) > 0.
→1660 RequestingPartyRole Char 1 Y Always "1"
PartyRole=1 (executing firm)
Identifies the type or role of the RequestingPartyID (tag 1658) specified.
453 NoPartyIDs groupSize 3 N minValue=1
maxValue=175
Number of PartyID (tag 448), PartyIDSource (tag 447), and PartyRole (tag 452) entries
Applicable only if specific Party Details Definitions are being requested; otherwise set to 0.
→448 PartyID uInt64 8 Y Required if NoPartyIDs (tag 453) > 0
Identification of the PartyDetailsListReqID of PartyDetailsDefinitionRequestAck.
→447 PartyIDSource Char 1 Y Always “C” – Generally accepted market participant identifier Required if NoPartyIDs(453) > 0.
Used to identify classification source.
→452 PartyRole uInt16 2 Y Always "1000" – PartyDetailsDefinition Required if NoPartyIDs(453) > 0.
Identifies the type of PartyID (tag 448).
-
Page:Establish (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39003 HMACVersion HMACVersion 0 Y CME-1-SHA-256 Constant. 39005 HMACSignature String32Req 32 Y Contains the HMAC signature.
HMAC signature will be calculated using HMAC data consisting of the following fields which should be in ascending order and delimited with new line (\n) characters. There should be no trailing new line.
- RequestTimestamp + '\n' +
- UUID + '\n' +
- SessionID + '\n' +
- FirmID+ '\n' +
- TradingSystemName + '\n' +
- TradingSystemVersion + '\n' +
- TradingSystemVendor + '\n' +
- NextSeqNo + '\n' +
- KeepAliveInterval
The HMAC signature is an encoded hash (digest) of the nine fields mentioned above using the Secret Key provided by CME.
In pseudo code:
HmacSHA256(HmacData, secretKey)
39004 AccessKeyID String20Req 20 Y Contains the AccessKeyID assigned to this session on this port.
For example: TXkgU2VjcmV0IEtleQ
1603 TradingSystemName String30Req 30 Y Provides the name of the application system used to generate FIX application messages. 1604 TradingSystemVersion String10Req 10 Y Provides the version of the application system being used to initiate FIX application messages 1605 TradingSystemVendor String10Req 10 Y Provides the vendor of the application system. 39001 UUID uInt64 8 Y Session Identifier defined as type long (uInt64); CME Group recommends using timestamp as number of microseconds since epoch (Jan 1, 1970).
- Unique at the beginning of the week on Sunday to start with sequence number 1
- Keep using same UUID in midweek Establish messages to maintain continuous sequence numbers
CME track of last known used UUID.
The Negotiate message must be sent prior to the Establish message with a new UUID midweek.
When used after Negotiate, Negotiate.UUID should have the same value as Etablish.UUID or the message will be rejected.
Client systems must use the same UUID for both primary and backup connections if using active-active fault tolerance to ensure that the sequence numbers will continue after a failover.
39002 RequestTimestamp uInt64 8 Y Time of request; CME Group recommends using the number of nanoseconds since epoch (Jan 1, 1970) as the timestamp. 39013 NextSeqNo uInt32 4 Y Next expected message sequence number.
On primary connection, the expected message sequence number of the next business message from customer to CME.
On primary connection the next expected message sequence number represents the sequence number of the next business message to be sent from customer to CME.
- At the beginning of the week this should be set to 1
- Should be set to last known message sequence number + 1 for Establish message sent midweek using same UUID as previous Establish message
- Should be set to 1 for Establish message sent midweek using different UUID from previous Establish message
On backup connection, this will be set to 0.
39006 Session String3Req 3 Y Session ID. 39007 Firm String5Req 5 Y Firm ID. 39014 KeepAliveInterval uInt16 2 Y The longest time in milliseconds the client system can remain silent before sending a keep alive message.
Allowed range is between 5000-60000. Any value outside this range will be rejected
If no message is sent from customer after 1 interval lapses, CME will send a Sequence message indicating that one keep alive interval from customer has lapsed.
If still no response is sent from the customer and the second keep alive interval lapses, the session will be terminated.
39008
Credentials
DATA
variable
N
Currently not supported; however the length of variable data needs to be set to 0, represented as two bytes 00 00.
-
Page:Negotiate (Electronic Platform Information Console) —
Tag Name
Binary Type Binary Length Req Enumeration Description 39000 CustomerFlow ClientFlowType 0 Y Idempotent Constant value representing type of flow from customer to CME. 39003 HMACVersion HMACVersion 0 Y CME-1-SHA-256 Constant. 39005 HMACSignature String32Req 32 Y Contains the HMAC signature.
HMAC signature will be calculated using HMAC data consisting of these fields which should be in ascending order and delimited with new line (\n) characters. There should be no trailing new line.
- RequestTimestamp + '\n' +
- UUID + '\n' +
- SessionID + '\n' +
- FirmID
The HMAC signature is an encoded hash (digest) of the four fields mentioned above using the Secret Key provided by CME.
In pseudo code:
HmacSHA256(HmacData, secretKey)
39004 AccessKeyID String20Req 20 Y Contains the AccessKeyID assigned to this session on this port.
For example: TXkgU2VjcmV0IEtleQ
39001 UUID uInt64 8 Y Session Identifier defined as type long (uInt64); CME Group recommends using the number of microseconds since epoch (Jan 1, 1970) as the timestamp.
- Unique at the beginning of the week on Sunday to start with sequence number 1
- Keep using same UUID in midweek Establish messages to maintain continuous sequence numbers
CME track of last known used UUID.
The Negotiate message must be sent prior to the Establish message with a new UUID midweek.
When used after Negotiate, Negotiate.UUID should have the same value as Etablish.UUID or the message will be rejected.
Client systems must use the same UUID for both primary and backup connections if using active-active fault tolerance to ensure that the sequence numbers will continue after a failover.
39002 RequestTimestamp uInt64 8 Y Time of request. CME Group recommends using the number of nanoseconds since epoch (Jan 1, 1970) as the timestamp. 39006 Session String3Req 3 Y Session ID. 39007 Firm String5Req 5 Y Firm ID. 39008 Credentials DATA 0 N Currently not supported; however the length of variable data needs to be set to 0, represented as two bytes 00 00.
-
Page:Sequence (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39001 UUID uInt64 8 Y Matches Establish.UUID used to establish the connection.
39013 NextSeqNo uInt32 4 Y Next expected message sequence number.
On the primary connection, the next expected message sequence number represents the sequence number of the next business message to be sent from the customer to CME or from CME to the customer.
On the backup connection, this will be set to 0.
Upon failover, the newly elected primary will send a Sequence message with NextSeqNo=the last message sequence number used by the primary + 1.
39010 FaultToleranceIndicator FTI 1 N 0=Backup
1=Primary
Indicates whether the connection is the primary or backup.
Upon failover, the newly elected primary will send a Sequence message with Status=1.
Not required to be sent from customer to CME.
39016
KeepAliveIntervalLapsed KeepAliveLapsed
1 Y 0=Not Lapsed
1=Lapsed
Indicates whether one Keep Alive interval has lapsed without any message received.
If an additional KeepAliveInterval lapses with no message received, then the socket connection will be disconnected.
-
Page:Retransmit Reject (Electronic Platform Information Console) —
Tag Name Binary Type Binary Length Req Enumeration Description 39011 Reason String48 48 N Reject reason details.
Will only be used for descriptive rejects.
39001 UUID uInt64 8 Y Matches RetransmitRequest.UUID.
39017 LastUUID uInt64NULL 8 N Matches RetransmitRequest.LastUUID.
39002 RequestTimestamp uInt64 8 Y Matches RetransmitRequest.RequestTimestamp. 39012 ErrorCodes uInt16 2 Y Rejection reasons:
0 - OutOfRange: FromSeqNo + Count is beyond the range of sequence numbers
1 - InvalidUUID: The specified UUID is unknown or is not authorized for the requester to access.
2 - RequestLimitExceeded: The message count exceeds maximum retransmission size of single request
3 - RetransmitAlreadyInProgress: Prior Retransmit still in progress so cannot send a new one
4 - InvalidTimestamp: Value sent by the client in RequestTimestamp is out of acceptable range (MIN, MAX)
5 - InvalidFromSeqNo: Value sent by the client in FromSeqNo is out of acceptable range (MIN, MAX)
6 - RequiredUUIDMisssing: null value in UUID field
7 - RequiredRequestTimestampMissing: null value in RequestTimestamp field
8 - RequiredFromSeqNoMissing: null value in FromSeqNo field
9 - RequiredMsgCountMissing: null value in MsgCount field
9553 SplitMsg SplitMsg 1 N 0=Split Msg Delayed
1=Out of Order Msg Delayed
2=Complete Msg Delayed
Indicates if a message was delayed as a result of:
- being split among multiple packets (0)
- TCP re-transmission (1)
- due to a previously submitted split or out of order message (2).
If absent then the message was not delayed, split, or received out of order.
- No labels