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

# Build an equity-volatility time series.

> Use this operation to evaluate one strike and maturity for multiple equities on each
business day in an inclusive range. The start date advances to the following business day when necessary.
The tabular result has a date column and one column per requested identifier, with null cells for missing dates.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetEquityVolTimeSeries
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/GetEquityVolTimeSeries:
    post:
      tags:
        - MarketData
      summary: Build an equity-volatility time series.
      description: >-
        Use this operation to evaluate one strike and maturity for multiple
        equities on each

        business day in an inclusive range. The start date advances to the
        following business day when necessary.

        The tabular result has a date column and one column per requested
        identifier, with null cells for missing dates.
      operationId: GetEquityVolTimeSeries
      requestBody:
        description: >-
          The query payload. Supply equity `Identifiers`, inclusive `StartDate`
          and `EndDate` values, one `Strike` interpreted by `StrikeType`,
          `Maturity` in days, and optional provider scope; the provider defaults
          to `Derivitec`.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolTimeSeriesRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolTimeSeriesRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolTimeSeriesRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityVolTimeSeriesRequest'
      responses:
        '200':
          description: >-
            Returns a date-indexed volatility table for the requested equities
            and any identifier, surface, or evaluation errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetEquityVolTimeSeriesResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetEquityVolTimeSeriesRequest:
      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
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/InstrumentIdentifier'
          description: >-
            Instrument selectors whose equity volatility time series are
            requested.
          nullable: true
        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
        strike:
          type: number
          description: Strike locating the requested equity volatility time series values.
          format: double
        maturity:
          type: integer
          description: >-
            Maturity as a day offset locating the requested equity-volatility
            time-series values.
          format: int32
        strike_type:
          enum:
            - absolute
            - logarithmic
            - normalized
            - logarithmic_spot
          type: string
          description: >-
            Strike type locating the requested equity volatility time series
            values.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityVolTimeSeriesRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Queries a dated equity-volatility series at one maturity and strike
        coordinate.
    ApiGetEquityVolTimeSeriesResponse:
      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:
          description: Dated equity-volatility observations returned by the query.
          type: array
          items:
            type: object
            additionalProperties: true
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityVolTimeSeriesResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Returns the dated equity-volatility observations matching the requested
        coordinate.
    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'
    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

````