Skip to main content
POST
Estimate equity volatility from convertible-bond prices.

Authorizations

Authorization
string
header
required

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

Body

The fitting payload. BondPriceData must be non-empty and supplies convertible-bond identifiers, date-only market dates, currencies, prices, and quotation flags. Provider/environment scope, optional MarketDataOverride, optional PricingModelManager, and decimal initial-volatility and bump-bound values control the fit.

Requests equity volatility surfaces fitted from convertible-bond prices and volatility-bump constraints.

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

bond_price_data
object[] | null

Convertible-bond prices consumed by the surface fit.

market_data_override
object

Optional market-data substitutions supplied with pricing, risk, or report calculations.

pricing_model_manager
object

Pricing-model configuration role accepted by calculation requests.

initial_atm_vol
number<double>

Initial at-the-money volatility expressed as a decimal; defaults to 0.5, meaning 50%.

min_vol_bump
number<double>

Lower volatility-bump constraint expressed as a decimal volatility shift; defaults to -0.95.

max_vol_bump
number<double>

Upper volatility-bump constraint expressed as a decimal volatility shift; defaults to 2.0.

Response

Returns fitted equity SVI surfaces and errors for invalid organisation scope, unsupported or non-convertible bonds, invalid overrides, missing prerequisite market data, or failed fits.

Returns equity volatility surfaces fitted from the convertible-bond inputs.

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

equity_vol_surfaces
object[] | null

Fitted equity volatility surfaces.