openapi: 3.2.0
info:
  title: Benchmark Mineral Intelligence Rare Earths API
  version: '2.0'
  description: The Benchmark API provides access to a comprehensive range of pricing data for various markets to empower your most critical energy transition decisions.
servers:
- url: http://localhost:3013/v2
- url: https://{environment}.benchmarkminerals.com/{version}
  variables:
    environment:
      enum:
      - api
      - dev-api
      - qa-api
      default: api
    version:
      enum:
      - v2
      default: v2
tags:
- name: Rare Earths
paths:
  /prices/rare-earths:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RareEarthsFindAllPricesRequest'
        required: true
      tags:
      - Rare Earths
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RareEarthsPricesApiResponse'
          description: Successful operation
      operationId: rare-earths-list-prices
      description: List prices
      security:
      - api_key:
        - rare-earths:read
        - prices:rare-earths
      summary: Rare earths list prices
      x-summary-source: derived
  /prices/rare-earths/summary:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RareEarthsFindSummaryPricesRequest'
      tags:
      - Rare Earths
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RareEarthsPricesSummaryApiResponse'
          description: Successful operation
        '401':
          description: unauthorized
      security:
      - api_key:
        - rare-earths:read
        - prices:rare-earths
      operationId: rare-earths-summary
      summary: Summary
  /prices/rare-earths/index:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RareEarthsIndexDTO'
        required: false
      tags:
      - Rare Earths
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexApiResponseV2'
          description: Successful operation
        '401':
          description: unauthorized
      security:
      - api_key:
        - rare-earths:read
        - prices:rare-earths
      operationId: rare-earths-index
      summary: Index
components:
  schemas:
    Currency:
      type:
      - object
      - 'null'
      properties:
        id:
          type: string
          example: 5c7f2d17-cae5-47f9-8e2f-abd141970e1b
        name:
          type: string
          example: Dollar
        iso:
          type: string
          example: USD
        symbol:
          type: string
          example: $
    RareEarthsRoutes:
      description: routes in the store
      type: array
      items:
        type: string
      example:
      - DDP China
    UnitOfMeasure:
      type: object
      properties:
        id:
          type: string
          example: 5c7f2d17-cae5-47f9-8e2f-abd141970e1b
        name:
          type: string
          example: Tonne
        symbol:
          type:
          - string
          - 'null'
          example: t
    Series:
      type: object
      properties:
        date:
          format: yyyy-MM-dd
          type: string
          example: 2023-01-31
        valueLow:
          type:
          - number
          - 'null'
          example: 1000
        valueHigh:
          type:
          - number
          - 'null'
          example: 2000
        valueMid:
          type: number
          example: 3000
    RareEarthsPricesSummaryApiResponse:
      type: object
      properties:
        $metadata:
          type: object
          properties:
            product:
              type: string
              example: Rare Earths
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: 5c7f2d17-cae5-47f9-8e2f-abd141970e1b
              name:
                type: string
                example: test
              alias:
                type:
                - string
                - 'null'
                example: null
              chemicalCode:
                type:
                - string
                - 'null'
                example: LC
              frequency:
                type: string
                example: monthly
              isSustainable:
                type: boolean
                example: false
              series:
                type: array
                items:
                  type: object
                  properties:
                    shippingRoute:
                      $ref: '#/components/schemas/ShippingRoute'
                    purity:
                      $ref: '#/components/schemas/Purity'
                    unitOfMeasure:
                      $ref: '#/components/schemas/UnitOfMeasure'
                    currency:
                      $ref: '#/components/schemas/Currency'
                    priceType:
                      $ref: '#/components/schemas/PriceType'
                    data:
                      $ref: '#/components/schemas/DataSummary'
    RareEarthsFindSummaryPricesRequest:
      type: object
      properties:
        categories:
          $ref: '#/components/schemas/RareEarthsCategories'
        shippingRoutes:
          $ref: '#/components/schemas/RareEarthsRoutes'
        purities:
          $ref: '#/components/schemas/RareEarthsPurities'
        unitOfMeasures:
          $ref: '#/components/schemas/UnitOfMeasuresRequest'
        currency:
          $ref: '#/components/schemas/CurrencyRequest'
        unit:
          $ref: '#/components/schemas/UnitRequest'
        priceTypes:
          description: Price type
          type: array
          items:
            type: string
          example:
          - Price
          - Weighted Average Price
    UnitOfMeasuresRequest:
      description: Units of measures for filtering data
      type:
      - array
      - 'null'
      items:
        type: string
      example:
      - t
      - kwh
      - '%'
    RareEarthsCategories:
      description: categories in the store
      type: array
      items:
        type: string
      example:
      - Praseodymium-Neodymium Oxide
      - Dysprosium Oxide
      - Terbium Oxide
      - Samarium Oxide
      - Li Price per Percentage Point
      - China Weighted Index
      - China Weighted Average
    ShippingRoute:
      type: object
      properties:
        id:
          type: string
          example: 5c7f2d17-cae5-47f9-8e2f-abd141970e1b
        name:
          type: string
          example: CIF Asia
        alias:
          type:
          - string
          - 'null'
          example: CIF Asia (Combined)
    UnitRequest:
      description: Drive on which data must be returned
      type:
      - string
      - 'null'
      enum:
      - t
      - kg
      - lb
      example: t
    RareEarthsFindAllPricesRequest:
      required:
      - from
      - to
      type: object
      properties:
        from:
          format: yyyy-MM-dd
          type: string
          example: 2023-01-31
        to:
          format: yyyy-MM-dd
          type: string
          example: 2023-01-31
        categories:
          $ref: '#/components/schemas/RareEarthsCategories'
        shippingRoutes:
          $ref: '#/components/schemas/RareEarthsRoutes'
        unitOfMeasures:
          $ref: '#/components/schemas/UnitOfMeasuresRequest'
        currency:
          $ref: '#/components/schemas/CurrencyRequest'
        unit:
          $ref: '#/components/schemas/UnitRequest'
        purities:
          $ref: '#/components/schemas/RareEarthsPurities'
        priceTypes:
          description: Price type
          type: array
          items:
            type: string
          example:
          - Price
          - Weighted Average Price
    RareEarthsPurities:
      description: purities in the store
      type: array
      items:
        type: string
      example:
      - '>22%>70%'
      - 99.0-99.5%
      - 99.0-99.9%
    Purity:
      type: object
      properties:
        id:
          type: string
          example: 5c7f2d17-cae5-47f9-8e2f-abd141970e7b
        name:
          type: string
          example: Min 99.0%
    IndexApiResponseV2:
      type: object
      properties:
        $metadata:
          type: object
          properties:
            product:
              type: string
              example: test
        data:
          type: object
          properties:
            summary:
              type: array
              items:
                type: object
                properties:
                  product:
                    type: string
                    example: test
                  updateFrequency:
                    type: string
                    example: monthly
                  order:
                    type: number
                    example: 1
                  data:
                    $ref: '#/components/schemas/DataSummaryIndex'
            detail:
              type: array
              items:
                type: object
                properties:
                  product:
                    type: string
                    example: test
                  order:
                    type: number
                    example: 1
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          format: yyyy-MM-dd
                          type: string
                          example: 2023-01-31
                        value:
                          type: number
                          example: 435.21
    RareEarthsIndexDTO:
      type:
      - object
      - 'null'
      properties:
        from:
          format: yyyy-MM-dd
          type: string
          example: 2023-01-31
        to:
          format: yyyy-MM-dd
          type: string
          example: 2023-01-31
        indexes:
          description: indexes in the store
          type:
          - array
          - 'null'
          items:
            type: string
          example:
          - Rare Earths
    DataSummaryIndex:
      type: object
      properties:
        today:
          type:
          - number
          - 'null'
          example: 1000
        last:
          type:
          - number
          - 'null'
          example: 1100
        latestChange:
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        yearOnYear:
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        yearToDate:
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
    RareEarthsPricesApiResponse:
      type: object
      properties:
        $metadata:
          type: object
          properties:
            product:
              type: string
              example: Rare Earths
        data:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: The name of the grade
              category:
                $ref: '#/components/schemas/Category'
              shippingRoutes:
                $ref: '#/components/schemas/ShippingRoute'
              unitOfMeasure:
                $ref: '#/components/schemas/UnitOfMeasure'
              currency:
                $ref: '#/components/schemas/Currency'
              priceType:
                $ref: '#/components/schemas/PriceType'
              purity:
                $ref: '#/components/schemas/Purity'
              series:
                type: array
                items:
                  $ref: '#/components/schemas/Series'
    PriceType:
      type: object
      properties:
        id:
          type: string
          example: 5c7f2d17-cae5-47f9-8e2f-abd141970e7b
        name:
          type: string
          example: Price
        order:
          type: number
          example: 3
    CurrencyRequest:
      type:
      - string
      - 'null'
      enum:
      - USD
      - CNY
      - JPY
      - AUD
      - KRW
      - EUR
      example: CNY
    DataSummary:
      type: object
      properties:
        today:
          type:
          - number
          - 'null'
          example: 1000
        last:
          type:
          - number
          - 'null'
          example: 1100
        latestChange:
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        dailyChange:
          description: Daily percentage change of the current value compared to the value from the previous day.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        weeklyChange:
          description: Weekly percentage change of the current value compared to the value from the previous week.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        biWeeklyChange:
          description: Bi-weekly percentage change of the current value compared to the value from two weeks ago.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        monthlyChange:
          description: Monthly percentage change of the current value compared to the value from the previous month.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        quarterlyMonthsChange:
          description: Quarterly percentage change of the current value compared to the value from three months ago.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        sixMonthsChange:
          description: Semi-annual percentage change of the current value compared to the value from six months ago.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        yearOnYear:
          description: Year-on-year percentage change of the current value compared to the value from the same period last year.
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
        yearToDate:
          type:
          - object
          - 'null'
          properties:
            value:
              type: number
              example: -5
            unit:
              type: string
              example: '%'
    Category:
      type: object
      properties:
        id:
          type: string
          example: 788353e5-3d01-4836-a333-9da2dc06141c
        name:
          type: string
          example: Lithium Carbonate
        alias:
          type:
          - string
          - 'null'
          example: null
        chemicalCode:
          type: string
          example: LC
        isSustainable:
          type: boolean
          example: false
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header