> ## 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 dividend-index fixings across dates.

> Use this operation to retrieve dividend-index fixing observations for requested indexes over an inclusive
date range. Results can include data from authorised provider scopes, with Derivitec fallback, and unsupported identifiers
or missing series are reported per index while other available series can still be returned.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetDividendIndexFixings
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/GetDividendIndexFixings:
    post:
      tags:
        - MarketData
      summary: Retrieve dividend-index fixings across dates.
      description: >-
        Use this operation to retrieve dividend-index fixing observations for
        requested indexes over an inclusive

        date range. Results can include data from authorised provider scopes,
        with Derivitec fallback, and unsupported identifiers

        or missing series are reported per index while other available series
        can still be returned.
      operationId: GetDividendIndexFixings
      requestBody:
        description: >-
          The query payload. `DividendIndexIds` must be non-empty; supply
          inclusive date-only `StartDate` and `EndDate` bounds plus optional
          provider or environment scope.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetDividendIndexFixingsRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetDividendIndexFixingsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetDividendIndexFixingsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetDividendIndexFixingsRequest'
      responses:
        '200':
          description: >-
            Returns available fixings keyed by input dividend-index identifier,
            together with unsupported-identifier, missing-data, or retrieval
            errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetDividendIndexFixingsResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetDividendIndexFixingsRequest:
      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
        dividend_index_ids:
          type: array
          items:
            $ref: '#/components/schemas/InstrumentIdentifier'
          description: Dividend index IDs selecting the requested dividend index fixings.
          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
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Queries dated dividend-index fixings by index and date range.
    ApiGetDividendIndexFixingsResponse:
      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
        dividend_index_fixings:
          type: array
          items:
            $ref: >-
              #/components/schemas/InstrumentIdentifierDividendIndexFixingIEnumerableKeyValuePair
          description: Dividend-index fixings returned by the query.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns dated dividend-index fixings and query errors.
    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'
    InstrumentIdentifierDividendIndexFixingIEnumerableKeyValuePair:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/InstrumentIdentifier'
        value:
          type: array
          items:
            $ref: '#/components/schemas/DividendIndexFixing'
          nullable: true
      additionalProperties: false
    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.
    DividendIndexFixing:
      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
        dividend_index_id:
          $ref: '#/components/schemas/InstrumentIdentifier'
        close:
          type: number
          description: Closing observation.
          format: double
        date:
          type: string
          description: Observation date.
          format: date-time
        fixing_type:
          type: string
          description: >-
            Classification of the dividend-index fixing; defaults to the literal
            Derivitec.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.DividendIndexFixing,
              Derivitec.Web.Core
      additionalProperties: false
      description: Dated fixing observation for a dividend index.
  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

````