Symbols Endpoint
Api will return a list of all available symbols.
mdx filename="Endpoint" GET /symbols Request Object
Parameters
apiKey string REQUIRED
Your unique API key. Note This may also be passed via x-api-key header.
Response Object
success boolean
true if the request was successful, false if there was an error.
message string OPTIONAL
error message if the request was unsuccessful.
statusCode string OPTIONAL
HTTP status code of the response, if the request was unsuccessful.
symbols object
object containing list of available symbols.
Response JSON
{
"success": true,
"symbols": [
{
"symbol": "WTIOIL",
"category": "Energy",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "Bbl",
"name": "Barrel"
},
"name": "Crude Oil WTI"
},
{
"symbol": "NG",
"category": "Energy",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "MMBtu",
"name": "Million British Thermal Units"
},
"name": "Natural Gas"
},
{
"symbol": "XAG",
"category": "Metals",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "T.oz",
"name": "Troy Ounce"
},
"name": "Silver"
},
{
"symbol": "BRENTOIL",
"category": "Energy",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "Bbl",
"name": "Barrel"
},
"name": "Crude Oil Brent"
},
{
"symbol": "XAU",
"category": "Metals",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "T.oz",
"name": "Troy Ounce"
},
"name": "Gold"
},
{
"symbol": "HG",
"category": "Metals",
"currency": {
"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"unit": {
"symbol": "Lb",
"name": "Pound"
},
"name": "Copper"
},
]
}