v2

latestOpenAPI 3.0.4Commercial License2026-08-0718678294.5 KB
Commodities

Get the callable commodity catalog

Retrieve metadata for callable commodity codes. Every item declares status and has_data. Pass include_unavailable=true to inspect discontinued, source-limited, and not-yet-served catalog entries.

get/v1/commodities

Query parameters

include_unavailableboolean
Example:true

Include configured commodities that currently have no served data.

include_discontinuedboolean

Include discontinued commodity definitions.

Response

List of all commodities

status'success' required

Example response

{
  "data": {
    "commodities": [
      {
        "code": "BRENT_CRUDE_USD",
        "name": "Brent Crude Oil",
        "currency": "USD",
        "category": "oil",
        "description": "North Sea Brent Crude Oil",
        "unit": "barrel",
        "unit_description": "Price per barrel",
        "multiplier": 100,
        "validation": {
          "max": 200
        },
        "price_change_threshold": 10,
        "sources": [
          {
            "label": "EIA",
            "role": "official_spot",
            "publication": {
              "cadence": "weekly_batch"
            },
            "collection": {
              "frequency": "daily at 21:00 UTC"
            }
          }
        ]
      }
    ]
  }
}