CME Reference Data API - Option Series Endpoint

CME Reference Data API - Option Series Endpoint

The Option Series endpoint is a 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 provides 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.

Authorization and Access

Access to CME Reference Data API Option Series URLs requires 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 thCME Reference Data API - Restricted Access.

API ID

Clients can use existing OAuth API IDs.

Entitlements

Entitlements are not required to access the Option Series endpoint.

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

 

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:

  • first listed

  • modified

Date in Time zone (CT)

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. 

  • Only sent if instrument is eligible to be listed 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.
Only applicable to ClearPort contracts.rice currency for an option.

String

exerciseStyleAmericanEuropean

Indicator for American or European option exercise style.

  • 0 = American style

  • 1 = European 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:

  • EQTY - Premium Style

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.

  • GBX=CME Globex Book Depth

  • GBI=CME Globex Implied Book Depth (under development)

 

clrSymbol

CLR Symbol: The product code used in CME Clearing for clearing reports like the Trade Register.

Example: “L1”

 

exchBusinessDate

Exchange business date.

  • For polls before 4:00 PM CT current exchange business date.

  • For polls after 4:00 PM CT this is the exchange next 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.

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?

Step 2. Click on https://refdata.api.uat.cmegroup.com/refdata/v3/instruments/3A7J4FWY7WR7

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?

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

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).




How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.