Term SOFR API - Get Term SOFR Rates - History

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.
URL/history
HTTP MethodGET
Contents

Request

Header Parameters


RefParameterNameTypeMultipleValuesUsageDescription
1

CME-Application-Name

Application NamestringNo
REQUIREDName of the customer system that generated the message.
2CME-Application-VendorApplication VendorstringNo
REQUIRED

Name of the vendor who provided the customer system. For a proprietary system, use the firm name.

3CME-Application-VersionApplication VersionstringNo
REQUIRED

Version identifier for the customer system.

Query Parameters

RefParameterNameTypeMulti-pleValuesUsageDescription
1productCodesProduct CodestringYes

TR1

TR3

TR6

T1Y

OPTIONAL

Indicates the underlying asset code (Product Code).


Clients can query for one or more Product Codes.

e.g productCodes=TR1,TR3 - Results will be limited to TR1 & TR3

2dateDatestringNo
OPTIONAL

A parameter to be used by the customer to specify a single date for which they want to obtain the rates. Format YYYY-MM-DD

3startDateStart DatestringNo
OPTIONAL

A parameter to be used by the customer to specify the lower bound within the desired date range. Format YYYY-MM-DD

4endDateEnd DatestringNo
OPTIONAL

A parameter to be used by the customer to specify the upper bound within the desired date range. Format YYYY-MM-DD

Response Headers

RefParameterNameTypeMultipleValuesUsageDescription
1

sentTime

Sent TimeTimeStampNo
REQUIREDTime the message was published
2versionVersionStringNo
REQUIRED

Version Number of the application generating the message

3datasetData SetstringNo
REQUIRED

Represents the type of data the application is generating

Response - 200

Successfully retrieved

Body

RefFieldNameData TypeValuesUsageDescription
1businessDtBusiness Datestring
REQUIRED

Trade date of published data. The relevant date for which the SOFR rates are in reference to. Format YYYY-MM-DD

2sofrRtSOFR Ratenumber
REQUIRED

SOFR Term Rate for this Tenor

4instrument[]Instrumentinstrument
REQUIRED
5→ guidIntInstrument GUID Intinteger
REQUIRED

Unique Instrument ID 

Can be used with Referential Data API to get Instrument details. 

6→ productCodeProduct Codestring

TR1

TR3

TR6

T1Y

REQUIRED

Indicates the underlying asset code (Product Code).

Can be used with Referential Data API to get Product 

Response - 500

Internal Server Error

Response - 400

Bad request Exception from incorrect user input e.g. incorrectly formatted date




How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.