Macro indicator
Query a macro indicator for a country.
Available data
- Returns
- Query a macro indicator for a country
- What each request returns
- Query the data selected by the endpoint parameters.
Authentication
Query Parameters
Choose the indicator and country; country_code is a compatible country selector
indicatorstringqueryExampleCPIrequiredEnter one macro indicator code (exact match). Common values: CPI, CORE_CPI, INFLATION_RATE, INFLATION_RATE_MOM, CORE_INFLATION_RATE, FEDERAL_FUNDS_RATE, GDP, GDP_GROWTH, GDP_ANNUAL_GROWTH, NONFARM_PAYROLL, UNEMPLOYMENT_RATE, LABOR_PARTICIPATION, CONSUMER_SPENDING, PPI, RETAIL_SALES, INDUSTRIAL_PRODUCTION, MONEY_SUPPLY_M2, CONSUMER_CONFIDENCE. Coverage varies by country or region
countrystringqueryExampleUnited StatesoptionalCountry or region
country_codestringqueryoptionalCountry or region code
latest returns snapshots; timeseries returns the available series. Date filters apply to timeseries
modestringqueryExamplelatestoptionalQuery mode · latest / timeseries
fromstringqueryoptionalRange start
tostringqueryoptionalRange end
start_timestringqueryoptionalInclusive UTC start; RFC3339, date or Unix seconds. Alias: from
end_timestringqueryoptionalExclusive UTC end; a date-only value includes that UTC day. Alias: to
sizeintegerqueryExample3optionalRow limit · ≥ 1, ≤ 400
Response
Response data
countnumberReturned row count
countrystringCountry or region
duration_msnumberduration_ms
indicatorstringMacro indicator
Latest metrics
Indicator snapshots
bea_series_codeunknown | nullbea_series_code
bls_series_idstringbls_series_id
countrystringCountry or region
datedatetimeDate
event_typestringevent_type
fred_series_idstringfred_series_id
indicatorstringMacro indicator
indicator_cnstringindicator_cn
modestringQuery mode
observation_datedatetimeobservation_date
previousnumberprevious
reference_periodstringReference period
slugnamestringslugname
sourcestringsource
timeseriesstringtimeseries
unitstringUnit
valuenumberValue
modestringQuery mode
sizenumberRow limit
totalnumberTotal matching records
data_statusDataStatusData status
empty_reasonunknown | nullReason for an empty result
errorunknown | nullStructured error; null when absent
external_refs[]unknown[]external_refs
lineage_refs[]unknown[]lineage_refs
Response metadata
actual_taskstringactual_task
data_statusDataStatusData status
limitations[]unknown[]Additional information
object_refs[]unknown[]object_refs
route_reasonstringroute_reason
updated_atdatetimeData update time
request_idstringRequest identifier
source_refs[]unknown[]source_refs