---
title: Commodity Symbols API Reference
version: 2.0.0
description: "Full catalog of 245+ supported commodities across Metals, Energy, Agriculture, Industrial, Raw Materials, Oils and Meals, Textiles, Meats, Poultry, and Livestock, with pricing currency, unit, and update interval per symbol. Deprecated symbols stay listed with `status: \"inactive\"` and a `deprecationDate`."
openapi: 3.1.1
servers:
  - https://api.apifreaks.com/v2.0
paths: 1
operations: 1
schemas: 4
---

## Table of Contents

- [Commodity Symbols API Reference v2.0.0](#commodity-symbols-api-reference-v200)
  - [Authentication](#authentication)
  - [Commodity APIs](#commodity-apis)
    - [getCommoditySymbols](#getcommoditysymbols)
      - [Parameters](#parameters)
      - [Responses](#responses)
  - [Schemas](#schemas)
    - [CommoditySymbolsResponse](#commoditysymbolsresponse)
    - [CommoditySymbolItem](#commoditysymbolitem)
    - [CommodityCurrency](#commoditycurrency)
    - [CommodityUnit](#commodityunit)



# Commodity Symbols API Reference v2.0.0

Full catalog of 245+ supported commodities across Metals, Energy, Agriculture, Industrial, Raw Materials, Oils and Meals, Textiles, Meats, Poultry, and Livestock, with pricing currency, unit, and update interval per symbol. Deprecated symbols stay listed with `status: "inactive"` and a `deprecationDate`.

Base URLs:

* [https://api.apifreaks.com/v2.0](https://api.apifreaks.com/v2.0)

## Authentication

* API Key (ApiKeyAuthHeader)
    - Parameter Name: **X-apiKey**, in: header. Pass your API key via the X-apiKey request header.

* API Key (ApiKeyAuthQuery)
    - Parameter Name: **apiKey**, in: query. Pass your API key via the apiKey query parameter.

## Commodity APIs

### getCommoditySymbols

`GET /commodity/symbols`

*Get all supported commodity symbols*

Returns the list of supported commodity symbols with metadata.

#### Parameters

|Name|In|Type|Required|Description|
|---|---|---|---|---|
|format|query|string|false|Response format. Accepted values: `json` (default) or `xml`.|

##### Enumerated Values

|Parameter|Value|
|---|---|
|format|json|

> Example responses

> Successful operation

```json
{
  "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"
      }
    },
    {
      "symbol": "NG-EU",
      "name": "Natural Gas, Europe",
      "category": "Energy",
      "status": "active",
      "updateInterval": "PER_MONTH",
      "exchange": "World Bank",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "MMBtu",
        "name": "Million British Thermal Units"
      }
    },
    {
      "symbol": "UANEU",
      "name": "Urea Ammonium Nitrate",
      "category": "Industrial",
      "status": "inactive",
      "updateInterval": "PER_MINUTE",
      "deprecationDate": "2024-04-14",
      "currency": {
        "code": "USD",
        "name": "US Dollar",
        "symbol": "$"
      },
      "unit": {
        "symbol": "T",
        "name": "Metric Ton"
      }
    }
  ]
}
```

#### Responses

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation|[CommoditySymbolsResponse](#commoditysymbolsresponse)|

#### Response Headers

|Status|Header|Type|Format|Description|
|---|---|---|---|---|
|200|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|

To perform this operation, you must be authenticated by means of one of the following methods:
ApiKeyAuthHeader, ApiKeyAuthQuery

## Schemas

### CommoditySymbolsResponse

Commodity symbols response containing an array of supported commodity symbol objects.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|success|boolean|true|none|Indicates whether the API request was successful.|
|symbols|[[CommoditySymbolItem](#commoditysymbolitem)]|true|none|Array of commodity symbol objects with metadata.|

### CommoditySymbolItem

A single commodity symbol with metadata.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|symbol|string|true|none|Unique identifier/ticker symbol for the commodity (e.g., XAU, NG-FUT). Use this value in the `symbols` parameter of the rate endpoints.|
|name|string|true|none|Full name of the commodity (e.g., Gold, Natural Gas Futures).|
|description|string|false|none|Short description of the commodity. May be an empty string for some symbols.|
|category|string|true|none|Category the commodity belongs to (e.g., Metals, Energy, Agriculture, Industrial, Raw Materials, Oils and Meals, Textiles, Meats, Poultry, Livestock).|
|status|string|true|none|Current status of the commodity. `inactive` means the symbol is deprecated: latest rates are unavailable, but historical rates remain available up to its `deprecationDate`.|
|updateInterval|string|true|none|Rate at which the price is updated.|
|exchange|string|false|none|Optional. Data source for the symbol (e.g., World Bank). Present only for some symbols.|
|deprecationDate|string(date)|false|none|Optional. Present only when `status` is `inactive`. Date the symbol was deprecated (YYYY-MM-DD).|
|currency|[CommodityCurrency](#commoditycurrency)|true|none|Currency information for a commodity.|
|unit|[CommodityUnit](#commodityunit)|true|none|Unit of measurement for a commodity.|

##### Enumerated Values

|Property|Value|
|---|---|
|status|active|
|status|inactive|
|updateInterval|PER_SECOND|
|updateInterval|PER_MINUTE|
|updateInterval|PER_10_MINUTES|
|updateInterval|PER_HOUR|
|updateInterval|PER_DAY|
|updateInterval|PER_WEEK|
|updateInterval|PER_MONTH|

### CommodityCurrency

Currency information for a commodity.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|code|string|true|none|ISO 4217 currency code.|
|name|string|true|none|Full name of the currency.|
|symbol|string|true|none|Symbol of the currency (e.g., $).|

### CommodityUnit

Unit of measurement for a commodity.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|symbol|string|true|none|Abbreviated unit symbol (e.g., T.oz, MMBtu).|
|name|string|true|none|Full name of the unit of measurement (e.g., Troy Ounce).|