Skip to main content
GET
List commodity prices

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

category
enum<string>

Filter by commodity category.

Commodity category.

Available options:
energy,
metals,
agriculture,
macro
Example:

"metals"

Free-text search on the commodity name.

Example:

"gold"

sort
enum<string>
default:name

Field to sort by.

Available options:
name,
price,
change_1d,
mtd,
ytd
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

Response

List of commodity price snapshots.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object[]
required
meta
object

Response metadata. Always present; timestamp is the server time the response was generated.