CME Reference Data API - Option Series Endpoint
Effective Sunday, March 30 (trade date Monday, March 31), clients will have access to a new CME Reference Data API endpoint named Option Series.
The Option Series endpoint is a new CME Reference Data API service that provides clients with the option series data, which describes the relevant attributes to determine which option contract and months/periods are eligible for trading; excluding strike prices, or put/call indicators.
This enhancement will provide clients with a simplified process to derive the tradable underlying outright futures of the options contract.
If no contracts currently exist, it is possible for a series to be active and available for trading even if there are no active contracts for the particular month due to some option contracts being created dynamically. For these products, the option series data contains the relevant high level attributes that are shared by all contracts in the option series.
Revision History
Date | Description |
---|---|
3/20/2025 | Initial publication of this pending client impact topic. |
Key Events and Dates
Date | Milestone |
---|---|
Currently Available | New Release |
March 30 | Production |
Testing and Certification
Testing is strongly recommended.
Certification is not required.
Client System Impacts
This section describes how clients access the new Option Series URLs along with message specifications.
Authorization and Access
Access to CME Reference Data API Option Series URLs require a registered OAuth API ID. API IDs for CME Group Logins are created and managed in the Customer Center under My Profile. For additional information on managing access please refer to the CME Reference Data API - Restricted Access.
API ID
Clients can use existing new release and production OAuth API IDs.
Entitlements
Entitlements are not required to access the new Option Series endpoint.
New URLs
Client systems will send Query Requests by invoking the HTTPS GET method to the following URLs:
Option Series URLs | |
---|---|
New Release | https://refdata.api.uat.cmegroup.com/refdata/v3/optionSeries |
Production | https://refdata.api.cmegroup.com/refdata/v3/optionSeries |
Message Specifications
Client systems making GET requests to the Option Series URLs will receive the following attributes in the JSON response.
ATTRIBUTE NAME | DESCRIPTION | TYPE
|
---|---|---|
series_guid | Unique identifier in alpha-numeric format for the options series. This unique identifier is used to query the instrument endpoint for all active options contracts listed under the option series record. | String |
series_guid_Int | Unique identifier in integer format for the options series. | Integer |
seriesName | Option series long name. |
|
positionRemovalDate | Position removal date. | Date |
lastUpdated | Timestamp from last time the instrument definition or product was updated:
| Date in Time zone (CST) |
lastTradeDate | Last date instrument is tradable across all venues and trade types | Date |
globexLastTradeDate | Last date instrument is tradable on CME Globex CLOB. | Date Format is in Central Time |
globexFirstTradeDate | The calendar date when the instrument becomes tradable on CME Globex.
| Date Format is in Central Time |
firstTradeDate | Clearing first trade date (actual contract trade date) | Date |
finalSettlementDate | Final settlement date: Final settlement date for futures | Date |
strikePxCcy | Strike pSpread tick. Used for any spread where there is no “non-consecutive-month” spread tick. | String |
exerciseStyleAmericanEuropean | Indicator for American or European option exercise style.
| String |
priceBandDl | Decimal locator for price band (priceBand). | String |
priceBand | Differential value for price bands on CME Globex. | String |
zeroPriceEligible | Y/N flag to indicate if instrument may be quoted and/or traded at a zero price. | String |
contractMonth | For monthly, quarterly and serial instruments identifies the named month and year in format YYYYMM. For all other instruments, identifies the month, year and date in format YYYYMMDD. | String |
valuationMethod | Type of valuation method used Valid values include but are not limited to:
| String |
tradeTick | Trade price tick. May differ from the settlementTick. | Double |
settlementTick | Used when instruments settle in a smaller tick than they are traded at; this field supports the settlement tick. | Double |
variableTickTable | Variable tick table for trading on CME Globex. | String |
vttLowTick | For some instruments, the tick is price dependent. This field defines the smallest tick the instrument can trade at. | Double |
vttHighTick | For some instruments, the tick is price dependent. This field defines the widest tick the instrument can trade at. | Double |
vttPriceThreshold | For some instruments, the tick is price dependent. This field defines the price threshold at which the minimum tick changes. | Double |
isUserDefined | UDS instruments (Under Development) | String |
uomCcy | Unit of measure currency | String |
isSyntheticInstrument | Boolean flag to identify Synthetic instruments ("Y", "N"). | String |
exchangeClearing | Exchange identifier used in the CME Group Post Trade Application. | String |
maxGlobexOrdQty | Maximum value allowed for a single quote or order on CME Globex. | String |
minGlobexOrdQty | Minimum order or quote size required on CME Globex. | String |
instrumentType | Description of instrument type. | String |
globexGroupCode | CME Globex uses this group code to identify logical groupings of products. CME Globex group code is only populated for instruments listed for trading on CME Globex. |
|
exchangeGlobex | 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. |
|
bookDepth | Globex market data book depth repeating group. |
|
mdFeedType | Globex market data feed type. Describes a class of service for a given data feed.
|
|
clrSymbol | CLR Symbol: The product code used in CME Clearing for clearing reports like the Trade Register. Example: “L1” |
|
exchBusinessDate | Exchange business date.
|
|
Embedded Links
The option series data includes imbedded links to the underlying outright futures instrument of the option series and a underlying link to the product endpoint listing all attributes of the option at the product level.
The underlying instrument link retrieves the related underlying outright futures instrument of the option series.
"_links": {
"self": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/optionSeries/SH3YJ7VXHXZU"
},
"underlyingInstrument": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/DGJKALZNGRTJ"
},
"product": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/products/I7VJGNSVZXV6"
}
Client Use Examples
The below examples is taken from the New Release environment on Friday, March 15, 2025.
Example 1
In this example the client use case is on using Option Series data (seriesGuid) to identify the options outright underlying futures.
Step 1. Client calls Option Series endpoint
https://refdata.api.uat.cmegroup.com/refdata/v3/optionSeries?
JSON Results
"_embedded": {
"optionSeries": [
{
"seriesGuid": "HHBJ3JBTYKZJ",
"seriesGuidInt": 260128895888272169,
"productGuidInt": 407792388124185644,
"seriesName": "EVENT CONTRACTS ON EUR/USD FUT - 20250319",
...
"seriesGuid": "N3IRVHRPCNPM",
"seriesGuidInt": 499074555062597100,
"productGuidInt": 1127137570280811180,
"seriesName": "EUR LOW SULPHUR GASOIL AMERICA OPT - 203104",
...
"_links": {
"self": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/optionSeries/N3IRVHRPCNPM"
},
"underlyingInstrument": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/3A7J4FWY7WR7"
},
"product": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/products/7JDFUX4ZLKVM"
}
}
}
Step 2. Click on https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/3A7J4FWY7WR7
JSON Results
{
"guid": "3A7J4FWY7WR7",
"guidInt": 973879098857216575,
"productGuidInt": 887632149350582487,
"instrumentName": "7FJ1 Future",
"globexSecurityId": "42000279",
"globexSymbol": "7FJ1",
"positionRemovalDate": "2031-04-10",
"lastUpdated": "2025-03-14T15:39:08",
"lastTradeDate": "2031-04-08",
"lastNoticeDate": null,
"lastDeliveryDate": null,
"globexLastTradeDate": "20310408103000",
"globexFirstTradeDate": "20241211163000",
...
"_links": {
"self": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/3A7J4FWY7WR7"
},
"overlyingInstruments": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/3A7J4FWY7WR7/overlyings"
},
"product": {
"href": "https://refdata.api.uat.cmegroup.com/refdata/v3/products/YUMAXSUUECGX"
}
}
}
Example 2
In this example the client use case is on using Option Series data (seriesGuid) and Instrument endpoint to retrieve all option contract in the series.
Step 1. Client calls Option Series endpoint
https://refdata.api.uat.cmegroup.com/refdata/v3/optionSeries?
JSON Results
"_embedded": {
"optionSeries": [
{
"seriesGuid": "HHBJ3JBTYKZJ",
"seriesGuidInt": 260128895888272169,
"productGuidInt": 407792388124185644,
"seriesName": "EVENT CONTRACTS ON EUR/USD FUT - 20250319",
...
"seriesGuid": "N3IRVHRPCNPM",
"seriesGuidInt": 499074555062597100,
"productGuidInt": 1127137570280811180,
"seriesName": "EUR LOW SULPHUR GASOIL AMERICA OPT - 203104",
Step 2. Select a option series record using seriesGuid (unique identifier)
"seriesGuid": "N3IRVHRPCNPM",
"seriesGuidInt": 499074555062597100,
"productGuidInt": 1127137570280811180,
"seriesName": "EUR LOW SULPHUR GASOIL AMERICA OPT - 203104",
...
Step 3. Query Instrument endpoint using seriesGuid to retrieve all option contracts in the option series.
https://refdata.api.uat.cmegroup.com/refdata/v3/instruments?seriesGuid=N3IRVHRPCNPM
JSON Results
"_embedded": {
"instruments": [
{
"guid": "2226P5IMIQTG",
"guidInt": 966970445910000230,
"productGuidInt": 1127137570280811180,
"instrumentName": "7FOJ31 75000 Call",
"globexSecurityId": "42619500",
"globexSymbol": "7FOJ31 C75000",
"positionRemovalDate": "2031-04-01",
"lastUpdated": "2025-03-14T15:39:14",
"lastTradeDate": "2031-04-01",
"lastNoticeDate": null,
"lastDeliveryDate": null,
"globexLastTradeDate": "20310401103000",
"globexFirstTradeDate": "20241212163000",
...
"seriesGuid": "N3IRVHRPCNPM",
...
},
"_metadata": {
"size": 1000,
"totalElements": 112,
"totalPages": 1,
"number": 0,
"type": "page"
}
Partner Exchange Impacts
There is no impact to partner exchanges.
Contact Information
For technical development support, contact Certification Support for Electronic Trading (CSET).
For production requests, please contact the Global Command Center (GCC).
For all other inquiries, please contact Global Account Management (GAM).
Related content
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.