> ## 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 commodity volatility surfaces. > Use this operation to retrieve complete volatility surfaces for requested commodity name/exchange pairs and market dates. Provider ID, one environment name, or multiple environment names can select authorised source scopes; when none is supplied, the shared `Derivitec` provider is used. The returned surface parameters retain their existing decimal volatility conventions, and no market data is modified. ## OpenAPI ````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetCmdtyVolSurfaces 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/GetCmdtyVolSurfaces: post: tags: - MarketData summary: Retrieve commodity volatility surfaces. description: >- Use this operation to retrieve complete volatility surfaces for requested commodity name/exchange pairs and market dates. Provider ID, one environment name, or multiple environment names can select authorised source scopes; when none is supplied, the shared `Derivitec` provider is used. The returned surface parameters retain their existing decimal volatility conventions, and no market data is modified. operationId: GetCmdtyVolSurfaces requestBody: description: >- The query payload. `CommodityIds` and date-only `MarketDates` must be non-empty. Populate only one of `ProviderId`, `MarketDataEnvironmentName`, or `MarketDataEnvironmentNames`. content: application/json-patch+json: schema: $ref: '#/components/schemas/ApiGetCmdtyVolSurfacesRequest' application/json: schema: $ref: '#/components/schemas/ApiGetCmdtyVolSurfacesRequest' text/json: schema: $ref: '#/components/schemas/ApiGetCmdtyVolSurfacesRequest' application/*+json: schema: $ref: '#/components/schemas/ApiGetCmdtyVolSurfacesRequest' responses: '200': description: >- Returns available commodity volatility surfaces and errors for invalid provider scope, unsupported commodities, or unavailable surfaces. content: application/json: schema: $ref: '#/components/schemas/ApiGetCmdtyVolSurfacesResponse' '400': description: BadRequest '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] - apikey: [] components: schemas: ApiGetCmdtyVolSurfacesRequest: 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 commodity_ids: type: array items: $ref: '#/components/schemas/CommodityId' description: Commodity IDs selecting the requested commodity volatility surfaces. nullable: true market_dates: type: array items: type: string format: date-time description: Market dates on which commodity volatility surfaces are requested. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetCmdtyVolSurfacesRequest, Derivitec.Web.Core additionalProperties: false description: Queries commodity volatility surfaces by commodity and market date. ApiGetCmdtyVolSurfacesResponse: 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 cmdty_vol_surfaces: type: array items: $ref: '#/components/schemas/CmdtyVolSurface' description: Commodity volatility surfaces returned by the query. nullable: true $type: type: string enum: - >- Derivitec.Web.Core.MarketData.ApiGetCmdtyVolSurfacesResponse, Derivitec.Web.Core additionalProperties: false description: Returns commodity volatility surfaces and query errors. CommodityId: required: - $type type: object properties: name: type: string description: Display name. nullable: true exchange: type: string description: Exchange component of the commodity key. nullable: true $type: type: string enum: - Derivitec.Web.Core.MarketData.CommodityId, Derivitec.Web.Core additionalProperties: false description: Commodity business key formed from name and exchange. CmdtyVolSurface: 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 commodity_id: $ref: '#/components/schemas/CommodityId' $type: type: string enum: - Derivitec.Web.Core.MarketData.CmdtyVolSurface, Derivitec.Web.Core additionalProperties: false description: Commodity volatility surface identified by its commodity. 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 ````