Skip to main content
GET
/
commodities
/
symbols
Available Symbols
curl --request GET \
  --url https://api.tradewatch.io/commodities/symbols \
  --header 'api-key: <api-key>'
{
  "items": [
    {
      "symbol": "<string>",
      "name": "<string>"
    }
  ],
  "total": 123,
  "current_page": "<string>",
  "current_page_backwards": "<string>",
  "previous_page": "<string>",
  "next_page": "<string>"
}

Authorizations

​
api-key
string
header
required

Authentication via API key header

Query Parameters

​
size
integer
default:10

The number of items per page.

​
type
enum<string> | null
default:all

Type of the commodity.

Available options:
agricultural,
energy,
metal,
all
​
cursor
string

Cursor for the next page

Response

Successful Response

​
items
SymbolsOutFull · object[]
required
​
total
integer | null

Total items

​
current_page
string | null

Cursor to refetch the current page

​
current_page_backwards
string | null

Cursor to refetch the current page starting from the last item

​
previous_page
string | null

Cursor for the previous page

​
next_page
string | null

Cursor for the next page