> ## 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 FX volatility surfaces for market dates.

> Use this operation to retrieve complete FX volatility surfaces for requested pairs and market dates from
one provider scope. When omitted, `ProviderId` defaults to `Derivitec`; this operation does not
modify market data.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetFxVolSurfaces
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/GetFxVolSurfaces:
    post:
      tags:
        - MarketData
      summary: Retrieve FX volatility surfaces for market dates.
      description: >-
        Use this operation to retrieve complete FX volatility surfaces for
        requested pairs and market dates from

        one provider scope. When omitted, `ProviderId` defaults to `Derivitec`;
        this operation does not

        modify market data.
      operationId: GetFxVolSurfaces
      requestBody:
        description: >-
          The query payload. `FxPairs` must be non-empty, `MarketDates` must be
          supplied as ISO 8601 date/time values, and `ProviderId` optionally
          identifies the source provider.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetFxVolSurfacesRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetFxVolSurfacesRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetFxVolSurfacesRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetFxVolSurfacesRequest'
      responses:
        '200':
          description: >-
            Returns the available FX volatility surfaces and any pair, date, or
            provider lookup errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetFxVolSurfacesResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetFxVolSurfacesRequest:
      required:
        - $type
      type: object
      properties:
        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
        fx_pairs:
          type: array
          items:
            type: string
          description: FX pairs that narrow the FX volatility surfaces operation.
          nullable: true
        market_dates:
          type: array
          items:
            type: string
            format: date-time
          description: Market dates on which FX volatility surfaces are requested.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetFxVolSurfacesRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Queries FX volatility surfaces by currency pair and market date.
    ApiGetFxVolSurfacesResponse:
      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
        fx_vol_surfaces:
          type: array
          items:
            $ref: '#/components/schemas/FxVolSurface'
          description: FX volatility surfaces returned by the query.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetFxVolSurfacesResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns FX volatility surfaces and query errors.
    FxVolSurface:
      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
        fx_pair:
          type: string
          description: Currency-pair code represented by the volatility surface.
          nullable: true
        is_quoted_fx_vol:
          type: boolean
          description: Whether this surface is marked as quoted FX volatility.
          example: false
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.FxVolSurface, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        FX volatility surface identified by its currency pair and quotation
        flag.
  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

````