> ## Documentation Index > Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve dividend-index volatility surfaces. > Use this operation to retrieve dividend-index volatility surfaces either by dividend-index identifier or by futures code. A futures code requests the contract expiry applicable to each market date. At least one identifier or futures code is required, and results are limited to the caller's authorised provider scopes. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetDividendIndexVolSurfaces openapi: 3.0.4 info: title: Derivitec Api 1.0 version: '1.0' servers: - url: https://api.riskportal.activeviam.com security: - oauth2: [] - apikey: [] tags: - name: AdminUser - name: AtotiReport - name: AtotiSession - name: BloombergOAuth - name: Bond - name: BondYieldCurvePage - name: BookAccess - name: Books - name: Commodity - name: Counterparties - name: Currencies - name: Equity - name: EquityDividend - name: EquityPage - name: FeatureFlag - name: Fx - name: FxPage - name: GroupAccess - name: Home - name: LegacyPosition - name: MarketData - name: MarketDataProvider - name: MarketDataProviderAccess - name: Meta - name: Notification - name: Organisation - name: PnLReport - name: PortfolioAccess - name: Portfolios - name: Position - name: PositionFilter - name: PricingEnvironment - name: PricingEnvironmentAccess - name: RateAsset - name: RateAssetPage - name: Report - name: ReportDefinition - name: ReportHistoryLauncherQuery - name: ReportLauncher - name: ReportQuery - name: ReportQueryViewUser - name: ReportRestriction - name: ReportView - name: RiskReport - name: Tradable - name: TradeBooking - name: User - name: VarReport - name: VarReportQuery - name: YieldCurvePage paths: /api/MarketData/GetDividendIndexVolSurfaces: post: tags: - MarketData summary: Retrieve dividend-index volatility surfaces. description: >- Use this operation to retrieve dividend-index volatility surfaces either by dividend-index identifier or by futures code. A futures code requests the contract expiry applicable to each market date. At least one identifier or futures code is required, and results are limited to the caller's authorised provider scopes. operationId: GetDividendIndexVolSurfaces requestBody: description: >- The query payload. Provide at least one entry across `DividendIndexIds` and `FuturesCodes`, non-empty date-only `MarketDates`, and optional provider or environment scope; neither identifier collection may be null. content: application/json-patch+json: schema: $ref: '#/components/schemas/ApiGetDividendIndexVolSurfacesRequest' application/json: schema: $ref: '#/components/schemas/ApiGetDividendIndexVolSurfacesRequest' text/json: schema: $ref: '#/components/schemas/ApiGetDividendIndexVolSurfacesRequest' application/*+json: schema: $ref: '#/components/schemas/ApiGetDividendIndexVolSurfacesRequest' responses: '200': description: >- Returns matching dividend-index surfaces plus unsupported or ambiguous futures-code, unsupported-index, validation, and missing-data errors. content: application/json: schema: $ref: '#/components/schemas/ApiGetDividendIndexVolSurfacesResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetDividendIndexVolSurfacesRequest: required: - $type type: object properties: provider_id: type: string description: >- Opaque identifier of a single market-data provider to use instead of either environment-name option. nullable: true entity_access_type: enum: - view - edit - owner - blocked type: string description: >- Access classification associated with the selected market-data environment. market_data_environment_names: type: array items: type: string description: >- Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives. nullable: true market_data_environment_name: type: string description: >- Single market-data environment name to use instead of `market_data_environment_names` or `provider_id`. nullable: true example: Example market data dividend_index_ids: type: array items: $ref: '#/components/schemas/InstrumentIdentifier' description: >- Dividend index IDs selecting the requested dividend index volatility surfaces. nullable: true futures_codes: type: array items: $ref: '#/components/schemas/InstrumentIdentifier' description: >- Futures codes selecting the requested dividend index volatility surfaces. nullable: true market_dates: type: array items: type: string format: date-time description: >- Market dates on which dividend index volatility surfaces are requested. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetDividendIndexVolSurfacesRequest, Derivitec.Web.Core additionalProperties: false description: >- Queries dividend-index volatility surfaces by index, futures code, and market date. ApiGetDividendIndexVolSurfacesResponse: required: - $type type: object properties: is_success: type: boolean description: >- Whether the operation completed successfully. The default is `true`; error outcomes set it to `false`. example: true error_messages: type: array items: type: string description: >- Messages explaining operation-level failures. The collection is empty by default. nullable: true dividend_index_vol_surfaces: type: array items: $ref: '#/components/schemas/DividendIndexVolSurface' description: Dividend-index volatility surfaces returned by the query. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetDividendIndexVolSurfacesResponse, Derivitec.Web.Core additionalProperties: false description: Returns dividend-index volatility surfaces and query errors. InstrumentIdentifier: description: >- Instrument code qualified by an identifier namespace and optional market code. discriminator: propertyName: $type mapping: Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core: '#/components/schemas/InstrumentIdentifierMintlifyShape' Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core: '#/components/schemas/InstrumentInfo' oneOf: - $ref: '#/components/schemas/InstrumentIdentifierMintlifyShape' - $ref: '#/components/schemas/InstrumentInfo' DividendIndexVolSurface: required: - $type type: object properties: provider_id: type: string description: >- Market-data provider code recorded as the source of the contribution. Defaults to Derivitec. nullable: true derivitec_created: type: string description: Timestamp at which the market-data record was created. derivitec_modified: type: string description: Optional timestamp of the record's latest modification. nullable: true uploaded_date_time: type: string description: >- Optional timestamp at which the contribution was uploaded. UploadRateAssets ignores the supplied value on each rate asset and stores the current UTC time. nullable: true derivitec_modified_by: type: string description: >- Principal recorded as the latest modifier. UploadRateAssets ignores the supplied value on each rate asset and stores the authenticated user identifier. nullable: true uploaded_by: type: string description: >- Principal recorded as the uploader. UploadRateAssets ignores the supplied value on each rate asset and stores the authenticated user identifier. nullable: true rolled: type: boolean description: Whether the contribution has been rolled. example: false benchmark_fwd_factors: type: array items: type: number format: double description: >- Positive benchmark forward-factor values, one corresponding by position to each benchmark maturity. nullable: true benchmark_maturities: type: array items: type: integer format: int32 description: >- Non-empty, non-negative, strictly increasing benchmark maturity offsets from ReferenceDate, in calendar days. nullable: true call_wings: type: array items: type: number format: double description: >- Non-negative call-wing parameter values, one corresponding by position to each benchmark maturity. nullable: true put_wings: type: array items: type: number format: double description: >- Non-negative put-wing parameter values, one corresponding by position to each benchmark maturity. nullable: true reference_date: type: string description: Reference date of the volatility surface. format: date-time skews: type: array items: type: number format: double description: >- Skew parameter values, one corresponding by position to each benchmark maturity. nullable: true smiles: type: array items: type: number format: double description: >- Smile parameter values, one corresponding by position to each benchmark maturity. nullable: true spot_ref: type: number description: Positive spot reference carried by the volatility surface. format: double vols: type: array items: type: number format: double description: >- Volatility observations expressed as decimals, where 0.20 means 20%, with one value corresponding by position to each benchmark maturity. nullable: true dividend_index_id: $ref: '#/components/schemas/InstrumentIdentifier' futures_code: $ref: '#/components/schemas/InstrumentIdentifier' $type: type: string enum: - >- Derivitec.Web.Core.MarketData.DividendIndexVolSurface, Derivitec.Web.Core additionalProperties: false description: Dividend-index volatility surface, optionally scoped to a futures code. InstrumentIdentifierMintlifyShape: required: - $type type: object properties: code: type: string description: Instrument code interpreted in the selected identifier namespace. nullable: true identifier_type: enum: - Derivitec - Ric - Bloomberg - Isin - Figi - Sedol - RedCode - RedPairCode - BloombergYellow - XIgniteCode - CBondsId - EdiSecId - EdiSymbol - Cusip - NotSet type: string description: Namespace that determines how the instrument code is interpreted. market_identification_code: type: string description: >- Optional market identification code that further qualifies the instrument code. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core additionalProperties: false description: >- Instrument code qualified by an identifier namespace and optional market code. InstrumentInfo: required: - $type type: object properties: code: type: string description: Instrument code interpreted in the selected identifier namespace. nullable: true identifier_type: enum: - Derivitec - Ric - Bloomberg - Isin - Figi - Sedol - RedCode - RedPairCode - BloombergYellow - XIgniteCode - CBondsId - EdiSecId - EdiSymbol - Cusip - NotSet type: string description: Namespace that determines how the instrument code is interpreted. market_identification_code: type: string description: >- Optional market identification code that further qualifies the instrument code. nullable: true name: type: string description: Human-readable name of the identified instrument. nullable: true $type: type: string enum: - Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core additionalProperties: false description: Instrument identifier with a human-readable instrument name. securitySchemes: oauth2: type: oauth2 description: >- OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header flows: implicit: authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize scopes: {} apikey: type: apiKey description: API-Key requested via the site and provided as a header name: x-api-key in: header ````