> ## Documentation Index
> Fetch the complete documentation index at: https://data-docs.orbbit.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Commodity Metric Values

> Get the values over time for the series you choose, each described in the same four layers..

Requires the `get-commodity-prices` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/commodities/metric-values
openapi: 3.1.0
info:
  title: Orbbit Data API
  version: '1.0'
  description: Commodity prices and packaged-food labels over one read-only REST API.
servers:
  - url: https://data-api.orbbit.co
    description: Production
security:
  - bearer: []
tags:
  - name: Commodities
  - name: Branded Food
paths:
  /v1/commodities/metric-values:
    get:
      tags:
        - Commodities
      summary: Get Commodity Metric Values
      description: >-
        Get the values over time for the series you choose, each described in
        the same four layers..


        Requires the `get-commodity-prices` scope.
      operationId: get_commodity_metric_values
      parameters:
        - name: metric_names
          required: false
          in: query
          description: >-
            Series metric names from `GET /v1/commodities`, separated by commas.
            You can ask for up to 100 series per call, counting `ids` and
            `metric_names` together.
          schema:
            type: string
        - name: ids
          required: false
          in: query
          description: >-
            Series ids from `GET /v1/commodities`, separated by commas. You can
            ask for up to 100 series per call, counting `ids` and `metric_names`
            together.
          schema:
            type: string
        - name: start_date
          required: false
          in: query
          description: >-
            The first day to include, as YYYY-MM-DD. Leave it out to get a
            recent stretch: 1 year for daily, weekly and biweekly series, 5
            years for monthly and 10 years for annual, counted back from the end
            date. For a full history, pass an early date such as 1990-01-01.
          schema:
            type: string
        - name: end_date
          required: false
          in: query
          description: >-
            The last day to include, as YYYY-MM-DD. Leave it out to end at each
            series' newest value.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPricesResponseDto'
              example:
                data:
                  - id: data_commodity_metric_01m5jbewxffcs9j3neja9k8s4a
                    metric_name: >-
                      cheese_block_cheddar_40_lb_us_chicago_wholesale_daily_close_price_usd_per_lb
                    product:
                      category: dairy
                      commodity: cheese
                      attributes:
                        size: 40 lb
                        cheese_form: block
                        cheese_style: cheddar
                    region: us_chicago
                    market_level: wholesale
                    freight: not_stated
                    frequency: daily
                    price_type: close
                    unit: usd_per_lb
                    measure: close_price
                    source: usda-mars
                    first_observed_on: '2021-02-24'
                    last_observed_on: '2026-10-20'
                    start_date: '2026-10-16'
                    end_date: '2026-10-20'
                    values:
                      - date: '2026-10-16'
                        value: 1.6825
                      - date: '2026-10-19'
                        value: 1.73
                      - date: '2026-10-20'
                        value: 1.8
        '400':
          description: >-
            A series that does not exist (the reply names it), more than 100
            series, an unknown parameter, a date that is not a real YYYY-MM-DD
            day, or a start date after the end date.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorDto'
              example:
                error:
                  type: invalid_request
                  message: 'Unknown metrics: cheddar_close'
        '401':
          description: The API key is missing, mistyped, unknown or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorDto'
              example:
                error:
                  type: unauthorized
                  message: 'Missing or malformed Authorization: Bearer header'
        '402':
          description: >-
            The balance, or this key's monthly spend limit, cannot cover this
            call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorDto'
              example:
                error:
                  type: insufficient_balance
                  message: Insufficient balance
        '403':
          description: This API key is not allowed to call this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorDto'
              example:
                error:
                  type: forbidden
                  message: This key is not scoped to get-commodity-prices
      security:
        - bearer: []
components:
  schemas:
    GetPricesResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: >-
                  Orbbit's ID for the series. Pass it to `GET
                  /v1/commodities/metric-values` as `ids`.
              metric_name:
                type: string
                description: >-
                  The series' readable name, built from its facts. Pass it to
                  `GET /v1/commodities/metric-values` as `metric_names`.
              product:
                type: object
                properties:
                  category:
                    type: string
                    description: >-
                      USDA's food group: `dairy`, `poultry`, `meat`, `grains`,
                      `fruits` or `vegetables`.
                  commodity:
                    type: string
                    description: >-
                      The thing priced, as one word, such as `corn`, `beef` or
                      `shell_eggs`.
                  attributes:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      anyOf:
                        - type: string
                        - type: array
                          items:
                            type: string
                    description: >-
                      What sets the product apart, one word to a value, such as
                      `{ "meat_cut": "breasts", "size": "40 lb" }`. A list where
                      several values apply.
                description: The product being priced. One product can have many series.
              region:
                type: string
                description: >-
                  Where the price applies, such as `us`, `us_wisconsin` or
                  `us_chicago`.
              market_level:
                type: string
                description: >-
                  The step in the supply chain where the price is paid: `farm`,
                  `wholesale` or `retail`.
              freight:
                type: string
                description: >-
                  USDA's shipping term: `fob` (at the seller's location),
                  `delivered`, or `not_stated`.
              frequency:
                type: string
                description: >-
                  How often USDA publishes the series: `daily`, `weekly`,
                  `biweekly`, `monthly` or `annual`.
              price_type:
                type: string
                description: >-
                  Which number this is: `low`, `high`, `avg`, `mostly_low`,
                  `mostly_high`, `close`, or `value` for a number published on
                  its own.
              unit:
                type: string
                description: >-
                  What each value is in, such as `usd_per_lb`, `usd_per_cwt` or
                  `usd_each`.
              measure:
                type: string
                description: >-
                  USDA's own name for the number, unchanged, such as
                  `wtd_avg_price` or `price_max`.
              source:
                type: string
                description: >-
                  The USDA report system: `usda-mars` (Market News reports) or
                  `usda-mpr` (Livestock Mandatory Reporting).
              first_observed_on:
                anyOf:
                  - type: string
                  - type: 'null'
                description: The date of the series' oldest value, `YYYY-MM-DD`.
              last_observed_on:
                anyOf:
                  - type: string
                  - type: 'null'
                description: >-
                  The date of the series' newest value, `YYYY-MM-DD`. Orbbit
                  checks USDA for new values every day.
              start_date:
                anyOf:
                  - type: string
                  - type: 'null'
                description: >-
                  The first day covered, `YYYY-MM-DD`: the `start_date` asked
                  for, or the default counted back from `end_date`. `null` only
                  for a series with no values when no dates were given.
              end_date:
                anyOf:
                  - type: string
                  - type: 'null'
                description: >-
                  The last day covered, `YYYY-MM-DD`: the `end_date` asked for,
                  or the series' newest value. `null` only for a series with no
                  values and no `end_date`.
              values:
                type: array
                items:
                  type: object
                  properties:
                    date:
                      type: string
                      description: The day the value applies to, `YYYY-MM-DD`.
                    value:
                      type: number
                      description: The value on that day, in the series' `unit`.
                description: The values in the range, oldest first.
          description: The series asked for, each with its values.
          x-nestjs_zod-uses-3-point-1-syntax: true
    PublicApiErrorDto:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            message:
              type: string
          x-nestjs_zod-self-required: true
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Your API key, which starts with `orbbit_data_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.