Skip to main content
GET
/
api
/
v1
/
market-indexes
curl -X GET "https://commodityai.app/api/v1/market-indexes?provider=Platts&commodity_group=iron_ore" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

[
  {
    "id": "823e4567-e89b-12d3-a456-426614174090",
    "provider": "Platts",
    "provider_code": "IODBZ00",
    "index_name": "Platts IODEX CFR China",
    "aliases": [
      "IODEX",
      "Platts CFR China",
      "Platts iron ore index",
      "TSI Iron Ore Fines"
    ],
    "commodity_group": "iron_ore",
    "product": "Iron ore fines",
    "basis": "CFR Qingdao / China",
    "quality": "61% Fe base effective Jan. 2, 2026",
    "currency_id": "d23e4567-e89b-12d3-a456-426614174013",
    "unit_id": "323e4567-e89b-12d3-a456-426614174002",
    "quote_unit_text": "dmt",
    "index_type": "outright",
    "status": "seed"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.commodityai.io/llms.txt

Use this file to discover all available pages before exploring further.

Market indexes identify external price references used in formula pricing, extraction, and contract normalization. Use this endpoint to resolve the market_index_id values accepted by pricing term components. These records do not contain market prices or quote history. They are reference data for recognizing and linking index names such as Platts IODEX, Fastmarkets MBIOI, Argus HRC, LME ferrous contracts, CME futures, and SGX swaps.

​
Read-Only Use

Market indexes are read-only integration lookups. CommodityAI may maintain system-level rows and company-specific rows, but external integrations should only read them unless write access has been explicitly enabled.

​
Query Parameters

​
provider
string
Filter by provider, such as Platts, Fastmarkets, Argus, LME, CME, or SGX.
​
provider_code
string
Filter by provider symbol or code, such as IODBZ00, MBIOI-62, MB-STE-0232, TIO, or HC.
​
commodity_group
string
Filter by broad commodity group, such as iron_ore, steel_flat, steel_long, ferrous_scrap, met_coal, met_coke, exchange_derivative, or steelmaking_raw_material_cost.
​
product
string
Filter by product text, such as Iron ore fines, Hot-rolled coil, Ferrous scrap, or Coking coal.
​
index_type
string
Filter by index type. Common values include outright, premium, differential, portside, exchange_settlement, and cost_index.
​
q
string
Search provider code, index name, aliases, product, basis, and quality.
​
all
boolean
default:"false"
When supported, returns the full system catalog instead of applying company-level reference exclusions.

​
Response Fields

FieldNotes
idMarket index UUID. Use this as market_index_id in pricing term components.
providerIndex provider or exchange, such as Platts, Fastmarkets, Argus, LME, CME, or SGX.
provider_codeProvider symbol or code when available.
index_nameCanonical index name shown to users and used by extraction flows.
aliasesAlternate names, broker wording, abbreviations, or old names.
commodity_groupBroad commodity bucket used for filtering and matching.
productProduct being priced.
basisCommercial market basis, such as CFR Qingdao, FOB China, or US Midwest.
qualityQuality basis when it matters for matching.
currency_idCurrency UUID for the quote currency when available.
unit_idUnit UUID when the quote unit maps cleanly to a canonical unit.
quote_unit_textProvider/display quote unit text, such as dmt, dmtu, gross ton, or mt.
index_typePricing index category.
statusCatalog status, such as seed, candidate, needs_verification, or customer_requested.

​
Request Example

curl -X GET "https://commodityai.app/api/v1/market-indexes?provider=Platts&commodity_group=iron_ore" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

​
Response Example

[
  {
    "id": "823e4567-e89b-12d3-a456-426614174090",
    "provider": "Platts",
    "provider_code": "IODBZ00",
    "index_name": "Platts IODEX CFR China",
    "aliases": [
      "IODEX",
      "Platts CFR China",
      "Platts iron ore index",
      "TSI Iron Ore Fines"
    ],
    "commodity_group": "iron_ore",
    "product": "Iron ore fines",
    "basis": "CFR Qingdao / China",
    "quality": "61% Fe base effective Jan. 2, 2026",
    "currency_id": "d23e4567-e89b-12d3-a456-426614174013",
    "unit_id": "323e4567-e89b-12d3-a456-426614174002",
    "quote_unit_text": "dmt",
    "index_type": "outright",
    "status": "seed"
  }
]

​
Pricing Term Usage

Reference a market index from a pricing term component: 
{
  "component_key": "index_price",
  "label": "Platts IODEX",
  "component_type": "market_index",
  "market_index_id": "823e4567-e89b-12d3-a456-426614174090",
  "currency_id": "d23e4567-e89b-12d3-a456-426614174013",
  "unit_id": "323e4567-e89b-12d3-a456-426614174002",
  "quote_unit_text": "dmt"
}
When matching index references from source documents, prefer exact provider_code matches first, then provider plus index_name or exact alias. Do not pick an index from product name alone when region, basis, quality, or exchange settlement is ambiguous.