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

# Calculate equity volatilities across a date range.

> Use this operation to calculate equity volatilities at multiple strikes and one maturity on
each business day in an inclusive range. The start date is advanced to the following business day when
necessary. `ProviderId` defaults to `Derivitec`, and the operation does not modify surfaces.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetEquityVols
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/GetEquityVols:
    post:
      tags:
        - MarketData
      summary: Calculate equity volatilities across a date range.
      description: >-
        Use this operation to calculate equity volatilities at multiple strikes
        and one maturity on

        each business day in an inclusive range. The start date is advanced to
        the following business day when

        necessary. `ProviderId` defaults to `Derivitec`, and the operation does
        not modify surfaces.
      operationId: GetEquityVols
      requestBody:
        description: >-
          The calculation payload. Supply one equity `Identifier`, inclusive
          `StartDate` and `EndDate` values, strikes interpreted according to
          `StrikeType`, `Maturity` in days, and an optional provider.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolsRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolsRequest'
      responses:
        '200':
          description: >-
            Returns evaluated volatility values and their strikes for each
            available business-date surface, together with retrieval or
            evaluation errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetEquityVolsResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetEquityVolsRequest:
      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
        identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        start_date:
          type: string
          description: Inclusive lower date-only boundary for the requested observations.
          format: date-time
        end_date:
          type: string
          description: Inclusive upper date-only boundary for the requested observations.
          format: date-time
        strikes:
          type: array
          items:
            type: number
            format: double
          description: Strikes locating the requested equity volatilities values.
          nullable: true
        maturity:
          type: integer
          description: >-
            Maturity as a day offset locating the requested equity-volatility
            values.
          format: int32
        strike_type:
          enum:
            - absolute
            - logarithmic
            - normalized
            - logarithmic_spot
          type: string
          description: Strike type locating the requested equity volatilities values.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityVolsRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Queries dated equity-volatility observations at one maturity and
        selected strikes.
    ApiGetEquityVolsResponse:
      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
        volatility_data:
          type: array
          items:
            $ref: '#/components/schemas/VolatilityData'
          description: Dated equity-volatility observations returned by the query.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityVolsResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns the selected equity-volatility observations.
    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'
    VolatilityData:
      required:
        - $type
      type: object
      properties:
        date:
          type: string
          description: Date of the volatility slice.
          format: date-time
        strike_type:
          enum:
            - absolute
            - logarithmic
            - normalized
            - logarithmic_spot
          type: string
          description: >-
            Coordinate convention used by the strike values. Defaults to
            absolute.
        strikes:
          type: array
          items:
            type: number
            format: double
          description: Strike-coordinate values carried by the slice.
          nullable: true
        vols:
          type: array
          items:
            type: number
            format: double
          description: Volatility observations carried by the slice.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.VolatilityData, Derivitec.Web.Core
      additionalProperties: false
      description: Dated volatility slice containing strikes and volatility observations.
    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

````