Skip to main content
POST
Download stored equity volatility-of-variance curves.

Authorizations

Authorization
string
header
required

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

Body

Non-empty qualified equity/index identifiers, the date-only MarketDate, and either MarketDataEnvironmentNames in priority order, MarketDataEnvironmentName, or ProviderId for readable environments; omit all to start at organisation data. Organisation and default provider fallback always apply.

Requests equity volatility-of-variance curves using market-data environment fallback.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetEqVolOfVarCurvesRequest, Derivitec.Web.Core
provider_id
string | null

Opaque identifier of a single market-data provider to use instead of either environment-name option.

entity_access_type
enum<string>

Access classification associated with the selected market-data environment.

Available options:
view,
edit,
owner,
blocked
market_data_environment_names
string[] | null

Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.

market_data_environment_name
string | null

Single market-data environment name to use instead of market_data_environment_names or provider_id.

Example:

"Example market data"

identifiers
object[] | null

Non-empty collection of qualified underlying equity/index identifiers, using the same identifier namespaces as uploads. Duplicate identifiers are returned once; unsupported identifiers fail the request.

Instrument code qualified by an identifier namespace and optional market code.

market_date
string<date-time>

Exact date-only reference date of the stored curves. Supply midnight; no timezone conversion or search for an earlier observation is performed. The time component is ignored.

Example:

"2026-10-05T00:00:00Z"

Response

Stored curves, or an unsuccessful response describing unsupported identifiers.

Stored volatility-of-variance curves for requested equity/index identifiers and an exact market date.

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

eq_vol_of_var_curves
object[] | null

Curves selected by provider priority, using the requested identifier namespaces. ProviderId identifies the source actually selected: preferred environment, organisation or default data. Each curve has calendar-day maturity offsets and decimal volatility values. Identifiers with missing curves across all providers are omitted; an empty list is successful when no marks exist on the requested date. No synthetic zero curves are returned.