Skip to main content
GET
Macro series

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_....

Path Parameters

iso
string
required

ISO 3166-1 country code (US), ISO 3166-2 first-level region code (AE-DU) or second-level region code (DE-KRS-09162, ES-SE).

Query Parameters

key
string
required

Series key, A-Z0-9_ (e.g. UNEMPLOYMENT_RATE). Keys come from GET /api/v1/countries/{iso}?view=catalog (or /regions?view=catalog&region= for a region, with &parent= for a second-level one).

Pattern: ^[A-Z0-9_]{1,64}$
from
string

First period, YYYY-MM-DD.

to
string

Last period, YYYY-MM-DD.

limit
integer

Latest N observations inside [from, to], 1–100000; window then reports total, returned and olderTo (the to that reads the points before).

Required range: 1 <= x <= 100000

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.

history
object[]
frequency
string
description
string
sourceName
string
source
object
title
string
units
string
seasonalAdjustment
string
window
object