Skip to main content
GET
Commodity spreads & ratios

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Query Parameters

asset_class
enum<string>
default:energy

Asset class.

Available options:
energy,
metals,
agriculture
key
string

One spread, e.g. BRENT_WTI: uppercase letters, digits and _ (else 400); unknown key 404.

view
enum<string>

summary: latest figures, no history. Cannot be combined with from, to, limit or frequency (400). full: every spread with its five-year history (no window). Omit for each history's last year.

Available options:
summary,
full
from
string<date>

First day of each history, YYYY-MM-DD.

to
string<date>

Last day of each history, YYYY-MM-DD.

limit
integer

Latest N points of each history, 1–100000; window.olderTo reads further back.

Required range: 1 <= x <= 100000
frequency
enum<string>
default:daily

Bar frequency: daily (the default), weekly or monthly (the last close of each week or month).

Available options:
daily,
weekly,
monthly

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

spreads
object[]