Skip to main content
POST
Store equity-to-dividend correlations.

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. Supply a non-empty CorrelationByEquityIdAndDividendId collection, a shared date-only MarketDate, and the partial-processing flag.

Submits dated equity-to-dividend-index correlations.

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

correlation_by_equity_id_and_dividend_id
object[] | null

Correlation values keyed by equity and dividend-index identifiers.

market_date
string<date-time>

Market date for the equity dividend 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 errors for invalid providers, unknown identifiers, out-of-range coefficients, empty input, or save failures.

Returns the success flag and error messages from an equity-to-dividend-index correlation upload.

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