SearchCtrl+K

Commodity Symbols API Reference

List all supported commodity symbols available in the APIFreaks Commodity API. Includes metals, energy, agriculture, and livestock.

GET

https://api.apifreaks.com/v1.0/commodity/symbols

Test

Returns a list of all tradable commodities with their symbols, names, categories, pricing currency, and unit of measurement.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'GET' \
  'https://api.apifreaks.com/v1.0/commodity/symbols' \
  -H 'X-apiKey: API-KEY'

Response

{
  "success": true,
  "symbols": [
    {
      "symbol": "XAU",
      "name": "Gold",
      "category": "Metals",
      "status": "active",
      "updateInterval": "PER_SECOND",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "T.oz",
        "name": "Troy Ounce"
      }
    },
    {
      "symbol": "NG-FUT",
      "name": "Natural Gas Futures",
      "category": "Energy",
      "status": "active",
      "updateInterval": "PER_MINUTE",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "MMBtu",
        "name": "Million British Thermal Units"
      }
    }
  ]
}

API Response Schema

A successful request returns a 200 OK response with an array of commodity symbols.

success

Booleanmandatory

Indicates whether the API request was successful.

symbols

Arraymandatory

An array of commodity symbol objects, each containing details about a tradable commodity.

symbols[].symbol

Stringmandatory

The unique identifier/ticker symbol for the commodity (e.g., "XAU", "NG-FUT").

symbols[].name

Stringmandatory

The full name of the commodity (e.g., "Gold", "Natural Gas Futures").

symbols[].category

Stringmandatory

The category the commodity belongs to (e.g., "Metals", "Energy").

symbols[].status

Stringmandatory

The current status of the commodity. Possible value: "active".

symbols[].updateInterval

Stringmandatory

The rate at which this commodity's price is updated. Possible values: "PER_SECOND", "PER_MINUTE".

symbols[].currency

Objectmandatory

An object containing information about the currency in which the commodity is priced.

symbols[].currency.code

Stringmandatory

The ISO 4217 currency code (e.g., "USD").

symbols[].currency.name

Stringmandatory

The full name of the currency (e.g., "US Dollar").

symbols[].currency.symbol

Stringmandatory

The symbol of the currency (e.g., "$").

symbols[].unit

Objectmandatory

An object describing the unit of measurement used for the commodity.

symbols[].unit.symbol

Stringmandatory

The abbreviated unit symbol (e.g., "T.oz" for Troy Ounce, "MMBtu" for Million British Thermal Units).

symbols[].unit.name

Stringmandatory

The full name of the unit of measurement (e.g., "Troy Ounce", "Million British Thermal Units").

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Please provide apiKey

Commodity Symbols API Reference

List all supported commodity symbols available in the APIFreaks Commodity API. Includes metals, energy, agriculture, and livestock.

GET

https://api.apifreaks.com/v1.0/commodity/symbols

Test

Returns a list of all tradable commodities with their symbols, names, categories, pricing currency, and unit of measurement.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'GET' \
  'https://api.apifreaks.com/v1.0/commodity/symbols' \
  -H 'X-apiKey: API-KEY'

Response

{
  "success": true,
  "symbols": [
    {
      "symbol": "XAU",
      "name": "Gold",
      "category": "Metals",
      "status": "active",
      "updateInterval": "PER_SECOND",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "T.oz",
        "name": "Troy Ounce"
      }
    },
    {
      "symbol": "NG-FUT",
      "name": "Natural Gas Futures",
      "category": "Energy",
      "status": "active",
      "updateInterval": "PER_MINUTE",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "MMBtu",
        "name": "Million British Thermal Units"
      }
    }
  ]
}

API Response Schema

A successful request returns a 200 OK response with an array of commodity symbols.

success

Booleanmandatory

Indicates whether the API request was successful.

symbols

Arraymandatory

An array of commodity symbol objects, each containing details about a tradable commodity.

symbols[].symbol

Stringmandatory

The unique identifier/ticker symbol for the commodity (e.g., "XAU", "NG-FUT").

symbols[].name

Stringmandatory

The full name of the commodity (e.g., "Gold", "Natural Gas Futures").

symbols[].category

Stringmandatory

The category the commodity belongs to (e.g., "Metals", "Energy").

symbols[].status

Stringmandatory

The current status of the commodity. Possible value: "active".

symbols[].updateInterval

Stringmandatory

The rate at which this commodity's price is updated. Possible values: "PER_SECOND", "PER_MINUTE".

symbols[].currency

Objectmandatory

An object containing information about the currency in which the commodity is priced.

symbols[].currency.code

Stringmandatory

The ISO 4217 currency code (e.g., "USD").

symbols[].currency.name

Stringmandatory

The full name of the currency (e.g., "US Dollar").

symbols[].currency.symbol

Stringmandatory

The symbol of the currency (e.g., "$").

symbols[].unit

Objectmandatory

An object describing the unit of measurement used for the commodity.

symbols[].unit.symbol

Stringmandatory

The abbreviated unit symbol (e.g., "T.oz" for Troy Ounce, "MMBtu" for Million British Thermal Units).

symbols[].unit.name

Stringmandatory

The full name of the unit of measurement (e.g., "Troy Ounce", "Million British Thermal Units").

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Please provide apiKey