> ## 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 equity-to-FX correlations for market dates.

> Use this operation to retrieve correlations between equities and FX crosses for requested market
dates. Each descriptor pairs an equity with a currency; the equity's listing currency determines the other
side of the FX cross. Unsupported equities are reported while correlations for supported pairs can still be returned.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/GetEquityFxCorrelation
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/GetEquityFxCorrelation:
    post:
      tags:
        - MarketData
      summary: Retrieve equity-to-FX correlations for market dates.
      description: >-
        Use this operation to retrieve correlations between equities and FX
        crosses for requested market

        dates. Each descriptor pairs an equity with a currency; the equity's
        listing currency determines the other

        side of the FX cross. Unsupported equities are reported while
        correlations for supported pairs can still be returned.
      operationId: GetEquityFxCorrelation
      requestBody:
        description: >-
          The query payload containing equity-and-currency
          `CorrelationDescriptors`, date-only `MarketDates`, and optional
          provider or environment scope.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityFxCorrelationRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityFxCorrelationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityFxCorrelationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetEquityFxCorrelationRequest'
      responses:
        '200':
          description: >-
            Returns available dated equity-to-FX correlations with provider and
            upload metadata, plus errors for unsupported equities or missing
            request inputs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetEquityFxCorrelationResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetEquityFxCorrelationRequest:
      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
        correlation_descriptors:
          type: array
          items:
            $ref: '#/components/schemas/EquityFxCorrelationDescriptor'
          description: >-
            Correlation descriptors selecting the requested equity FX
            correlation.
          nullable: true
        market_dates:
          type: array
          items:
            type: string
            format: date-time
          description: Market dates of the requested equity-to-FX correlations.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityFxCorrelationRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Queries dated correlations between selected equities and FX pairs.
    ApiGetEquityFxCorrelationResponse:
      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
        equity_fx_correlation_data:
          type: array
          items:
            $ref: '#/components/schemas/EquityFxCorrelationData'
          description: Dated equity-to-FX correlation observations returned by the query.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiGetEquityFxCorrelationResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns dated equity-to-FX correlation observations.
    EquityFxCorrelationDescriptor:
      required:
        - $type
      type: object
      properties:
        equity_identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        currency:
          type: string
          description: Currency used to select the FX side of the requested pair.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityFxCorrelationDescriptor,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Equity identifier and currency used to request an equity-to-FX
        correlation.
    EquityFxCorrelationData:
      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
        correlation:
          type: number
          description: >-
            Unitless correlation between the two selected instruments, in the
            range -1 to 1.
          format: double
        date:
          type: string
          description: Observation date.
          format: date-time
        equity_identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        currency:
          type: string
          description: >-
            Currency used with the equity's listing currency to select the FX
            cross.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityFxCorrelationData,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Dated correlation between an identified equity and a currency-derived FX
        cross.
    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

````