CME Term SOFR API

CME Term SOFR API

The CME Term SOFR API is a REST API that provides access to daily set of forward-looking interest rate estimates, calculated and published for 1-month, 3-month, 6-month and 12-month tenors in real-time, along with complete history of CME Term SOFR Reference Rates.

Contents

Additional Resources

Additional Resources

CME Term SOFR

Onboarding

CME Term SOFR API uses OAuth, 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 CME Term SOFR 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 CME Term SOFR API is not required. 

Availability

The CME Term SOFR 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.

The latest rates will publish and be available around 10:00 AM UTC.

Accessing CME Term SOFR API

This section describes the message specifications and URLs to access CME Term SOFR API.

CME Term SOFR API URLs

Below are the base URLs to access the CME Term SOFR API endpoints:

Environment

Base URL

Environment

Base URL

Production

https://markets.api.cmegroup.com/term-sofr-rates/v1

Message Specifications

The business message specifications for CME Term SOFR 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

Name

Path

Method

Description

Get Term SOFR Rates - Latest

/latest

GET

Gets the Latest Term SOFR Rates for the current date. By default returns the Latest Term SOFR rates for all four products.

Accepts the below requests/inputs: 

  1. If no arguments / parameters are provided -> Returns all four of the latest Term SOFR rates for the current date.

  2. If only one Product (productCodes) is provided -> Returns the requested product with the latest Term SOFR rate.

  3. If multiple Products (productCodes) are provided, separated by "," (comma) -> Returns the requested products with the latest Term SOFR rate for each.

Get Term SOFR Rates - History

/history

GET

Gets historical Term SOFR rates based on a single date or range of dates provided by the customer. By default returns all historical Term SOFR rates.

Accepts the below requests/inputs:

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

  2. If (startDate) field is provided but no (endDate) field -> The (endDate) field will be defaulted to today/current-date. Returns Term SOFR rates between the range of the specified (startDate) and today/current-date.

  3. If (endDate) field provided but no (startDate) field -> Returns all Term SOFR rates up to customer-provided (endDate).

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

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

  6. If only (date) field is provided -> Returns the SOFR Term Rate for the customer-provided date.

  7. If date (field) is provided with (startDate) or (endDate) -> The date field takes precedence. Returns the SOFR Term Rate for the customer-provided date.

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

  9. If only one Product (productCodes) is provided -> Returns the requested product with the historical Term SOFR rate.

  10. If multiple Products (productCodes) are provided, separated by "," (comma) -> Returns the requested products with the historical Term SOFR rate for each.

Response Metadata fields

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

Field

Description

Usage

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.