> ## 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.

# Run an interest-rate swaption volatility-cube lookup.

> Use this operation to process a rate-asset swaption volatility request for one market date and provider
scope. Optional strike spreads, market quotes, SABR parameters, and volatility type control the lookup.
Provider lookup includes the selected provider, the caller's organisation, and the default
`Derivitec` provider. The operation is read-only and waits for processing to complete, but the current
endpoint does not return a response body containing the retrieved cube or processing errors.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetSwaptionVolCubeData
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/GetSwaptionVolCubeData:
    post:
      tags:
        - MarketData
      summary: Run an interest-rate swaption volatility-cube lookup.
      description: >-
        Use this operation to process a rate-asset swaption volatility request
        for one market date and provider

        scope. Optional strike spreads, market quotes, SABR parameters, and
        volatility type control the lookup.

        Provider lookup includes the selected provider, the caller's
        organisation, and the default

        `Derivitec` provider. The operation is read-only and waits for
        processing to complete, but the current

        endpoint does not return a response body containing the retrieved cube
        or processing errors.
      operationId: GetSwaptionVolCubeData
      requestBody:
        description: >-
          The query payload. `MarketDate` is required; `RateAssetName`
          identifies the rate asset, `StrikeSpreads` are requested strike
          offsets, and the include flags, `VolType`, and provider/environment
          fields control processing detail and source scope. This endpoint does
          not return the processed cube.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetSwaptionVolCubeDataRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetSwaptionVolCubeDataRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetSwaptionVolCubeDataRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetSwaptionVolCubeDataRequest'
      responses:
        '200':
          description: >-
            Indicates that the swaption volatility-cube request completed
            without a response body.
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetSwaptionVolCubeDataRequest:
      required:
        - $type
      type: object
      properties:
        market_date:
          type: string
          description: Market date of the requested volatility cube.
          format: date-time
        strike_spreads:
          type: array
          items:
            type: number
            format: double
          description: Strike-spread coordinates requested from the volatility cube.
          nullable: true
        include_sabr_parameters:
          type: boolean
          description: >-
            Whether the lookup requests fitted SABR parameter detail; this
            selector does not guarantee a response body.
        market_data_environment_name:
          type: string
          description: >-
            Name of the market-data environment to use. Supply either this name
            or `provider_id`, not both.
          nullable: true
          example: Example market data
        provider_id:
          type: string
          description: >-
            Opaque identifier of the market-data provider to use. Supply either
            this identifier or `market_data_environment_name`, not both.
          nullable: true
        rate_asset_name:
          type: string
          description: Rate asset whose swaption volatility cube is requested.
          nullable: true
        include_market_quotes:
          type: boolean
          description: >-
            Whether the lookup requests market-quote detail; this selector does
            not guarantee a response body.
        vol_type:
          enum:
            - black
            - bachelier
          type: string
          description: Volatility representation requested from the cube.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetSwaptionVolCubeDataRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Queries a swaption volatility cube by rate asset, volatility type,
        market date, and strike spreads.
  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

````