Skip to main content
POST
Retrieve bond yield curves for market dates.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The query payload. BondYieldCurveIds and date-only MarketDates must be non-empty. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope.

Queries selected bond yield curves across market dates, with an optional shared-data fallback.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetBondYieldCurvesRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

bond_yield_curve_ids
object[] | null

Bond yield curve IDs selecting the requested bond yield curves.

market_dates
string<date-time>[] | null

Market dates on which bond yield curves are requested.

fallback_on_derivitec_data
boolean

Whether the lookup may fall back to the alternative Derivitec data source.

Response

Returns available bond yield curves and errors for invalid provider scope, unknown issuers, or unavailable curves on requested dates.

Returns issuer bond yield curves and query errors.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetBondYieldCurvesResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

bond_yield_curves
object[] | null

Issuer bond yield curves returned by the query.