Product Parameter Specifications
The following parameters can be used to query product information.
Either a direct match, or searches using the wildcard "*" can be used for queries.
Parameters can be used together by using ampersand (&) between search terms; however if the same parameter is used twice in the same GET request (for example, exchangeGlobex=XCME&exchangeGlobex=XNYM) only the last one will be used (in this case: exchangeGlobex=XNYM).
Parameter | Valid Values | Description |
|---|---|---|
assetClass |
| Query for products by asset class. Note: Not all products have a defined assetClass. |
assetSubClass | Query for all products by asset sub class:
| |
blockTradeEligible | Y,N | Query for all products eligible or ineligible for block trading Not applicable to BrokerTec |
clearingOrgID | e.g.
| Will return the entity where the trade will be cleared |
clearingSymbol | Query for products by CME Clearing product code | |
clearportEligible | Y,N | Query for products available on or excluded from CME ClearPort Not applicable to BrokerTec |
dailyFlag | Y,N | Query for or excluding daily products Not applicable to BrokerTec |
ebfEligible | Y,N | Query for products eligible or ineligible for EBF trading Not applicable to BrokerTec |
efpEligible | Y,N | Query for products eligible or ineligible for EFP trading Not applicable to BrokerTec |
exchangeClearing |
| Query for all products by Exchange identifier used in the Post Trade Application. |
exchangeGlobex |
| Query for all products by the Market Identifier Code (MIC) as defined by the ISO. For inter-exchange spreads, this field contains the hybrid value displayed in the Market Data Platform Security Definition (tag 35=d) message tag 207-SecurityExchange. |
exerciseStyle | Query for products by the human-readable options exercise instructions. Not applicable to BrokerTec | |
fixingSource |
| Query by instrument fixing source. |
flexEligible | Y,N | Query for products eligible or ineligible for Flex trading Not applicable to BrokerTec |
floorCallSymbol | Query for products by the Floor Call Symbol Not applicable to BrokerTec | |
floorEligible | Y,N | Query for products eligible or ineligible for trading on the floor Not applicable to BrokerTec |
floorPutSymbol | Query for products by the Floor Put Symbol Not applicable to BrokerTec | |
globexEligible | Y,N | Query for products eligible or ineligible for trading on CME Globex |
globexGroupCode | Query for products by CME Globex group code (MDP 3.0 tag 1151-Security Group) | |
globexProductCode | Query for outright products using the CME Globex Product Code (MDP 3.0 tag 6937-Asset) For spreads and combinations (securityType=COMBO), the CME Globex Product Code will be postpended with additional information. To ensure you receive all product records, CME Group recommends querying with a wild card when using this parameter, for example: "globexProductCode=CL*" Examples of globexProductCodes for combos:
| |
goodForSession | Y,N | Boolean flag (“Y”,”N”) to identify GFS (Good For Session) TimeInForce eligibility on CME Globex. |
ilinkEligible | Y,N | Query for products eligible for iLink Mass Quote order entry on CME Globex. |
isBticProduct | Y,N | Query for Basis Trade at Cash Open (BTIC) products Not applicable to BrokerTec |
isEfixProduct | Y, N | "Y" will return all eFix Match products. |
isTacoProduct | Y,N | Query for Trade at Cash Open (TACO) products Not applicable to BrokerTec |
isTamProduct | Y,N | Query for Trade at Marker (TAM) products Not applicable to BrokerTec |
isTasProduct | Y,N | Query for Trade at Settlement (TAS) products Not applicable to BrokerTec |
isTmacProduct | Y,N | Boolean flag identifies whether the overlying product is a TMAC product. |
marketSegmentId | Query for all products traded on a CME Globex Market Segment May be null for some BrokerTec products | |
massQuoteEligible | Y,N | Query for products eligible or ineligible for Mass Quoting on CME Globex |
masterSymbol | Query for all products under an individual master symbol. This code is only used to associate outright instruments (futures and options) with the product-level spreads/combos. It is not a meaningful attribute of the product itself. This is the only way to query for all products associated with a single business product. For example: ?masterSymbol=SR will return all SOFR products including the futures, options, calendar and bundle spreads BrokerTec - Under Development | |
modifiedAfter | Input a time in UNIX millisecond timestamp format to receive all products modified on or after a certain date. Example: modifiedAfter=1478473019000 | Query for all products modified after the specifIed date. |
modifiedBefore | Input a time in UNIX millisecond timestamp format to receive all products modified on or before a certain date. Example: modifiedBefore=1478473019000 | Query for all products modifed before the specified date. |
negativePxEligible | Y,N | Query for all products eligible or ineligible to trade at negative prices on CME Globex |
negativeStrikeEligible | Y,N | Query for all products eligible or ineligible to list strikes at negative prices Not applicable to BrokerTec |
onMtf | Y,N | Query for all products eligible or ineligible for On-MTF. |
onSef | Y,N | Query for all products eligible or ineligible for On-SEF. |
otcEligible | Y,N | Query for all products eligible or ineligible for OTC trading. Not applicable to BrokerTec |
page | 1...[N] | Retrieve a specific page from the product service |
productGuidInt | Unique product identifier in integer-only format. | |
productName | Legal Product Name. | Query for the human-readable product name. |
rbtEligibleInd | Y or N | Will return all RBT products Note: RBT eligible products are not traded on CME Globex. |
rfqCrossEligible | Y,N | Query for products eligible or ineligible for R-Cross on CME Globex |
sector | Query for all products in the specified Subgroup as reflected on cmegroup.com For BrokerTec Tradable Products the following values:
| |
securityType |
| Query for all products by type |
settleMethod | Valid values:
| Settlement Method. Indicates if product is financially or physically settled. |
size | 1-1000 | Specify the number of results returned per page |
strategyType | Query on strategy type, e.g. "RV", "SP", "FX", "BF" etc.. | |
subSector | Query for all products in the specified Category as reflected on cmegroup.com May be null for BrokerTec | |
subtype | Y,N | Query for all products by type |
symbol | Query for all products using symbol across all venues. Product code searches using this parameter will return all products with that code across any/all trading venues and CME Clearing:
| |
tradePxCcy | Query for all products with the specified trade currency | |
unitOfMeasure | Query for all products with the specified Unit of Measure for the contract. For example, "IPNT" (Index Points) for E-mini S&P Futures. Unit of measure values are defined here. |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.