Skip to main content

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.

These read-only endpoints return common reference data used across contracts, shipments, costs, pricing, and logistics.

​
Endpoints

Code setEndpointNotes
CountriesGET /api/v1/countriesReturns id, name, code. Supports all=true.
CurrenciesGET /api/v1/currenciesReturns id, name, code, symbol. Supports all=true.
Units of measureGET /api/v1/units-of-measureReturns id, name, code. Supports all=true.
Unit conversionsGET /api/v1/unit-conversionsReturns source unit, target unit, and conversion factor. Supports all=true.
PortsGET /api/v1/portsReturns port ID, code, country ID, country code, and country name. Supports all=true.
Packaging typesGET /api/v1/packaging-typesReturns id, name, code. Supports all=true.
Container typesGET /api/v1/container-typesReturns id, name, code. Supports all=true.
ExchangesGET /api/v1/exchangesReturns id, name, code, city. Supports all=true.
Standard payment termsGET /api/v1/standard-payment-termsReturns company payment term templates used by contracts.

​
Query Parameters

​
all
boolean
default:"false"
When supported, returns the full global set instead of applying company-level reference exclusions.

​
Request Example

curl -X GET "https://commodityai.app/api/v1/currencies" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

​
Response Examples

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "US Dollar",
    "code": "USD",
    "symbol": "$"
  }
]