> ## 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 reference and market details.

> Use this operation for the pair identifier/name, domestic and foreign currency codes, spot, effective
market date, and trading-calendar identifier. Use the pair `Code` returned by `GetFxPairs`.
Provider/environment selection controls the spot contribution. A missing spot is represented as zero and
a missing name as `N/A`. The operation is read-only and completes before returning.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Fx/GetFxInfo
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/Fx/GetFxInfo:
    post:
      tags:
        - Fx
      summary: Retrieve FX reference and market details.
      description: >-
        Use this operation for the pair identifier/name, domestic and foreign
        currency codes, spot, effective

        market date, and trading-calendar identifier. Use the pair `Code`
        returned by `GetFxPairs`.

        Provider/environment selection controls the spot contribution. A missing
        spot is represented as zero and

        a missing name as `N/A`. The operation is read-only and completes before
        returning.
      operationId: GetFxInfo
      requestBody:
        description: >-
          A slash-delimited `FxPair`, date-only `MarketDate`, and one authorised
          provider-selector form.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiFxGetInfoRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiFxGetInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiFxGetInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiFxGetInfoRequest'
      responses:
        '200':
          description: >-
            Returns the FX reference and market details, including the calendar
            ID used by `GetFxCalendar`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiFxGetInfoResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiFxGetInfoRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: >-
        Selects an FX pair and market-data date for quote, currency, name, and
        calendar details.
      properties:
        fx_pair:
          type: string
          description: FX pair selected by derived requests.
          nullable: true
        market_date:
          type: string
          description: Market date used by the derived request.
          format: date-time
        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
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiFxGetInfoRequest,
              Derivitec.Web.Core
    ApiFxGetInfoResponse:
      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
        provider_id:
          type: string
          description: >-
            Opaque identifier of the market-data provider associated with the
            returned data.
          nullable: true
        identifier:
          type: string
          description: Resolved FX-pair identifier returned by the lookup.
          nullable: true
        market_date:
          type: string
          description: Market-data date copied from the request.
          format: date-time
        name:
          type: string
          description: >-
            FX-pair name, or the literal N/A when the name lookup returns an
            empty string.
          nullable: true
        domestic_currency:
          type: string
          description: Domestic currency code derived from the selected FX pair.
          nullable: true
        foreign_currency:
          type: string
          description: Foreign currency code derived from the selected FX pair.
          nullable: true
        spot:
          type: number
          description: >-
            Spot quote for the selected pair and market-data date; zero is
            returned when unavailable.
          format: double
        trading_calendar_id:
          type: string
          description: Calendar code derived from the selected FX pair.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiFxGetInfoResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns descriptive and spot details for the selected FX pair.
  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

````