Skip to main content
GET
Country dashboard

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 alpha-2 country code (e.g. US).

Query Parameters

view
enum<string>
default:profile

profile (default): the payload without macroSeries (plus seriesCount, branches: the country page's tabs and sub-tabs, each with the MCP tool and argument that reads it, and views). full: the whole dashboard with every series card. catalog: the series as rows without histories — { series: [{ key, title, unit, category, frequency, latest, latestPeriod, stale, staleAfterDays, source }], total, offset, limit, nextOffset, categories }; stale is true when latestPeriod is older than the series' cadence allows (more than staleAfterDays days after the period's first day), null when the cadence is unknown. economy: one Economy sub-tab (section) as the page draws it — headline cards, its questions (modules) with their cards, charts and table, then the sub-tab's other series paged by limit / offset ({ total, limit, offset, hasMore, nextOffset }; next_offset is a deprecated copy of nextOffset); each card carries latest, prior and year-ago prints and change_1y; without section, the sub-tabs the country fills. central_bank: section overview | statistics | financials, built from series. government: the Government sections and the parts each is made of — per part path (the route that reads it) and query (its parameters, e.g. section=votes), plus view / args (the same part as get_government arguments). The profile leaves out the dashboard's always-empty placeholder fields (indices, fx, news, …); full keeps them.

Available options:
profile,
full,
catalog,
economy,
central_bank,
government
section
string

economy: growth_activity, labour_market, inflation_prices, consumption_households, housing_real_estate, credit_funding, trade_external, fx, energy, tourism_transport, industry_technology, fiscal. central_bank: overview, statistics, financials. catalog: an Economy sub-tab slug, to list the series that pane draws.

q
string

catalog: words that must all appear in the title, key or publisher.

category
string

catalog: one indicator category (output, prices, labor, rates, money, …).

limit
integer

catalog: rows, 1–500 (default 100). economy / central_bank: other series per page, 0–200 (default 40).

offset
integer

catalog, economy, central_bank: rows to skip.

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.

country
object
views
object
iso2
string
name
string
series
object[]
total
integer
offset
integer
limit
integer
nextOffset
integer
categories
object