> ## 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 commodity fixing history.

> Use this operation for dated close fixings for one commodity over a date range, ordered oldest first. This
legacy action reads the shared Derivitec contribution; inherited provider-selector fields do not narrow the
history. The action does not require non-empty identifiers or impose date-range ordering. It is read-only and
completes before returning.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Commodity/GetHistory
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/Commodity/GetHistory:
    post:
      tags:
        - Commodity
      summary: Retrieve commodity fixing history.
      description: >-
        Use this operation for dated close fixings for one commodity over a date
        range, ordered oldest first. This

        legacy action reads the shared Derivitec contribution; inherited
        provider-selector fields do not narrow the

        history. The action does not require non-empty identifiers or impose
        date-range ordering. It is read-only and

        completes before returning.
      operationId: GetHistory
      requestBody:
        description: >-
          A commodity name/exchange `Identifier` and date-only
          `StartDate`/`EndDate`; inherited provider selectors do not change the
          returned history.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiCommodityGetHistoryRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCommodityGetHistoryRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiCommodityGetHistoryRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiCommodityGetHistoryRequest'
      responses:
        '200':
          description: >-
            Returns available fixing dates and close values, or a no-data error
            in the response payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCommodityGetHistoryResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiCommodityGetHistoryRequest:
      required:
        - $type
      type: object
      properties:
        identifier:
          $ref: '#/components/schemas/CommodityId'
        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
        start_date:
          type: string
          description: First calendar date supplied to the commodity fixing-history lookup.
          format: date-time
        end_date:
          type: string
          description: Last calendar date supplied to the commodity fixing-history lookup.
          format: date-time
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiCommodityGetHistoryRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Selects a commodity and calendar-date range for close-fixing history.
    ApiCommodityGetHistoryResponse:
      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
        commodity_data:
          type: array
          items:
            $ref: '#/components/schemas/CommodityDataPoint'
          description: Dated commodity close fixings ordered from earliest to latest.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiCommodityGetHistoryResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Returns the available commodity close fixings in ascending date order.
    CommodityId:
      required:
        - $type
      type: object
      properties:
        name:
          type: string
          description: Display name.
          nullable: true
        exchange:
          type: string
          description: Exchange component of the commodity key.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.CommodityId, Derivitec.Web.Core
      additionalProperties: false
      description: Commodity business key formed from name and exchange.
    CommodityDataPoint:
      required:
        - $type
      type: object
      properties:
        fixing_date:
          type: string
          description: Calendar date of the close fixing.
          format: date-time
        close:
          type: number
          description: Close value recorded for the fixing date.
          format: double
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.CommodityDataPoint,
              Derivitec.Web.Core
      additionalProperties: false
      description: Pairs a commodity fixing date with its recorded close value.
  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

````