Skip to main content
POST
Store strike volatility grids for equities.

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. EquityVolGrids must be non-empty; each grid supplies an equity identifier, date-only reference date, strike convention, maturities, strikes, volatilities, spline choice, and optional spot reference.

Submits equity volatility grids.

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

use_best_effort
boolean

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

equity_vol_grids
object[] | null

Equity volatility grids to upload.

Response

Returns whether volatility surfaces were stored and errors for invalid grids, providers, identifiers, or missing prerequisite market data.

Returns the success flag and error messages from an equity volatility-grid upload.

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