Skip to main content
POST
Store recovery rates.

Authorizations

Authorization
string
header
required

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

Body

The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. RecoveryRateData must be non-empty and each row supplies service IssuerId and ReferenceBondId values, a date-only market date, and decimal Rate in the range [0, 1].

Submits dated recovery-rate observations.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadRecoveryRatesRequest, 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.

recovery_rate_data
object[] | null

Dated recovery-rate observations to upload.

Response

Returns whether all recovery rates were stored and errors for invalid providers, missing identifiers, out-of-range rates, or write failures.

Returns the success flag and error messages from a recovery-rate upload.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiUploadRecoveryRatesResponse, 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.