Skip to main content
POST
Store dividend-index volatility surfaces.

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. VolSurfaces must contain at least one surface with a dividend-index identifier or futures code, reference date, spot reference, and aligned SVI parameter vectors; Vols values use decimal volatility units.

Submits dividend-index volatility surfaces.

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

vol_surfaces
object[] | null

Dividend-index volatility surfaces to upload.

Response

Returns whether any surfaces were stored and errors for invalid providers, unsupported or ambiguous identifiers, conflicting duplicates, or invalid surface data.

Common operation outcome containing a success indicator and any error messages.

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