Skip to main content
POST
Store FX/interest-rate correlations for a market-data provider.

Authorizations

Authorization
string
header
required

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

Body

The upload payload. Supply correlation rows with conventional FX pair codes and interest-rate instrument identifiers, an ISO 8601 MarketDate, a writable ProviderId, and the UseBestEffort partial-processing flag.

Submits dated FX-to-interest-rate correlations.

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

fx_ir_correlations
object[] | null

Dated FX-to-interest-rate correlation observations to upload.

market_date
string<date-time>

Market date for the FX interest-rate correlation operation.

use_best_effort
boolean

Requests independent handling of input records when one cannot be processed; defaults to false.

Response

Returns whether correlations were stored and any invalid-provider or unknown-identifier errors.

Returns the success flag and error messages from an FX-to-interest-rate correlation upload.

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