> ## 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 pricing environment settings.

> Returns settings for one pricing environment available to the current caller. This operation is read-only and
does not require a separate owner or administrator role. The selected name must identify an accessible
environment; no default selection or additional format rule is declared.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/PricingEnvironment/GetPricingEnvironmentSettings
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/PricingEnvironment/GetPricingEnvironmentSettings:
    post:
      tags:
        - PricingEnvironment
      summary: Retrieve pricing environment settings.
      description: >-
        Returns settings for one pricing environment available to the current
        caller. This operation is read-only and

        does not require a separate owner or administrator role. The selected
        name must identify an accessible

        environment; no default selection or additional format rule is declared.
      operationId: GetPricingEnvironmentSettings
      requestBody:
        description: >-
          JSON request with required environment `Name`. No default selection or
          additional format rule is declared.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiPricingEnvironmentSettingsGetRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiPricingEnvironmentSettingsGetRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiPricingEnvironmentSettingsGetRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiPricingEnvironmentSettingsGetRequest'
      responses:
        '200':
          description: >-
            Returns the selected environment's settings, or an unsuccessful
            envelope when it is unavailable to the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPricingEnvironmentSettingsGetResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiPricingEnvironmentSettingsGetRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: >-
        Name of an accessible pricing environment whose public settings are
        requested.
      properties:
        name:
          type: string
          description: >-
            Name of the entity to select within the request's entity category.
            The value must not be null or empty.
          nullable: true
          example: Example entity
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.PricingEnvironment.ApiPricingEnvironmentSettingsGetRequest,
              Derivitec.Web.Core
    ApiPricingEnvironmentSettingsGetResponse:
      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
        pricing_environment:
          $ref: '#/components/schemas/PricingEnvironment'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.PricingEnvironment.ApiPricingEnvironmentSettingsGetResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Public settings for the selected pricing environment.
    PricingEnvironment:
      required:
        - $type
      type: object
      properties:
        equity_indices_to_decompose:
          type: object
          additionalProperties:
            type: boolean
          description: >-
            Map of equity-index identifiers to flags selecting which indices are
            decomposed; initialised empty.
        bloomberg_live_data_configuration:
          $ref: '#/components/schemas/BloombergLiveDataConfiguration'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.PricingEnvironment.PricingEnvironment,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Public index-decomposition and live-data-code settings for a pricing
        environment.
    BloombergLiveDataConfiguration:
      required:
        - $type
      type: object
      properties:
        bbg_exchange_code_map:
          type: object
          additionalProperties:
            type: string
          description: >-
            Optional exchange-code substitutions used for stock live-data
            identifiers.
        bbg_code_map:
          type: object
          additionalProperties:
            type: string
          description: >-
            Optional substitutions from Risk Portal instrument identifiers to
            live-data provider codes, including any sector suffix needed by the
            configured provider.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.PricingEnvironment.BloombergLiveDataConfiguration,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Public code-substitution maps used by a pricing environment for live
        market-data identifiers.
  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

````