CVOL End-of-Day API

CVOL End-of-Day API

The CME Group Volatility Index (CVOL) End-of-Day API is a REST API that provides access to daily and historical sets of CVOL end-of-day index levels and analytics. 

Contents

Onboarding

CVOL End-of-Day API uses OAuth authentication, an open protocol that supports secure authorization in a simple, standard method and decouples authentication from authorization. More details about OAuth API ID authorization and authentication are available in Client API Service Adoption using OAuth 2.0 Protocol.

To access the CVOL End-of-Day API, client API IDs must be entitled. Request access from the CME Group Market Data API self-service onboarding page or contact Global Account Management (GAM).

Testing and Certification

Certification for CVOL End-of-Day API is not required. 

Availability

The CVOL End-of-Day API is available 24 hours a day, 7 days a week. Clients systems should consider all returned data to be accurate at the time of the request submission.

CVOL End-of-Day rates are published as below in UTC:

Trading Day

Non-Daylight Savings Time (UTC)

Daylight Savings Time (UTC)

Monday

Tuesday 02:05 a.m.

Tuesday 01:05 a.m.

Tuesday

Wednesday 02:05 a.m.

Wednesday 01:05 a.m.

Wednesday

Thursday 02:05 a.m.

Thursday 01:05 a.m.

Thursday

Friday 02:05 a.m.

Friday 01:05 a.m.

Friday

Monday* 03:00 a.m.

Monday* 02:00 a.m.

*Note: For Friday data, the rates are published on Monday or the Next Business Day if Monday is a holiday

Access CVOL End-of-Day API

To access the CVOL End-of-Day API endpoints in the Production environment, an OAuth API ID and access token are required.

CVOL End-of-Day API URLs

Below are the base URLs to access the CVOL End-of-Day API endpoints:

Environment

Base URL

Production

https://markets.api.cmegroup.com/cvol-eod/v1

Message Specifications

The business message specifications for CVOL End-of-Day API are available below. 

  • The Path value, prefixed with Base URL, will be a specific end point for the HTTPS GET request.

  • Each HTTPS GET call must have the header parameter "Authorization" with value "Bearer" pre-pended to the OAuth token (including a space separator).
    example: "Bearer <Oauth Access token>"

Name

Path

Method

Description

Get CVOL Indices - Latest

/cvol-eod/latest

GET

Gets the Latest CVOL Indices for the current date. By default returns the Latest CVOL Indices. Note clients will only get the indices that clients have entitlements for. 

Accepts the below requests/inputs: 

  1. If no arguments / parameters are provided -> Returns all of the latest CVOL Indices. (if the latest for an Indice is greater than 14 days it is not returned in the latest data set)

  2. If only one Product (productCodes) is provided -> Returns the requested product with the latest CVOL Indices.

  3. If multiple Products (productCodes) are provided. A list of productCodes is comma separated -> Returns the requested products with the latest CVOL Indices for each.

  4. If only one Asset (assetClasses) is provided -> Returns the CVOL Indices for the requested asset class.

  5. If multiple Asset (assetClasses) is provided -> Returns the CVOL Indices for the requested asset classes.

Get CVOL Indices - History

/cvol-eod/history

GET

Gets historical CVOL Indices based on a single date or range of dates provided by the customer. By default returns all historical CVOL Indices. Note clients will only get the indices that clients have entitlements for. 

Accepts the below requests/inputs:

  1. If both (startDt) and (endDt) fields are provided -> Returns an inclusive range between customer-provided (startDt) and (endDt).

  2. If (startDt) field is provided but no (endDt) field -> The (endDt) field will be defaulted to today/current-date. Returns CVOL Indices between the range of the specified (startDt) and today/current-date.

  3. If (endDt) field provided but no (startDt) field -> Returns all CVOL Indices up to customer-provided (endDt).

  4. If no Date fields are provided -> Returns all historical CVOL Indices based on the customer-provided product codes leading up to today/current-date.

  5. If no arguments / parameters are provided -> Returns all historical CVOL Indices leading up to today/current-date.

  6. If only (date) field is provided -> Returns the CVOL Indices for the customer-provided date.

  7. If (date) field is provided as well as (startDt) or (endDt) -> The (date) field takes precedence. Returns the CVOL Indices for the customer-provided date.

  8. If all 3 Date fields are provided -> The (date) field takes precedence. Returns the CVOL Indices for the customer-provided date.

  9. If only one Product (productCodes) is provided -> Returns the requested product with the historical CVOL Indices.

  10. If multiple Products (productCodes) are provided -> Returns the requested products with the historical CVOL Indices.

  11. If only one Asset (assetClasses) is provided -> Returns the requested asset class with the historical CVOL Indices.

  12. If multiple Asset (assetClasses) is provided -> Returns the requested asset classes with the historical CVOL Indices.

Response Metadata Fields

The following information describes the metadata JSON element on the response payload to client systems.

Field

Description

Usage

pageSize

Maximum number of data elements in the JSON result set or page.

Defaults to 1000 with a maximum of 2000.

Can be used as a query parameter to limit the number of elements returned per request.

E.g. /history?pageSize=500

totalPages

Total number of pages in the full result set.

 

pageNumber

The current page in the set of pages.

If totalPages is greater than 1, pageNumber is used to navigate to the next page of the result set.

E.g. /history?pageNumber=2 (retrieve the second page in the data set)

totalElements

Value indicates the total Elements in the full data set.

 

type

Type of JSON data set.

Always set to value “page”

elementsInReponse

Number of data elements in the JSON result set or page.

 

Contact Information

For production requests, contact the Global Command Center (GCC).

For other inquiries, contact Global Account Management (GAM).




How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.