Plan: Professional and above · Credits: 1 per call for search and values; the catalog lookup is free
GET /v1/macro/series
Search the series we serve.q is full text over the title, the country’s name in every spelling (Vietnam and Viet Nam both work, so do UK and DEU), and concept tags — Taiwan inflation finds the consumer price index and euro area inflation finds HICP. When no row matches every word, the words are retried as alternatives so JGB 10 year still finds the 10-year JGB yield.
Results put the monthly, quarterly and daily official series first and the World Bank annual series last, never excluded: Indonesia unemployment is answered by a World Bank row. Pass frequency=A or country= to reach those rows directly.
string
Words to match:
Vietnam GDP, nonfarm payrolls, 10 year yield, Japan CPI.string
Two-letter ISO code.
EU is the euro area.string
One of
actuals (published statistics), rates (market and policy rates), central_bank (targets and balance sheets), implied (breakevens), nowcast (model estimates).string
One of
D, W, M, Q, A, or EVENT for series that change on the day a decision takes effect.integer
default:"50"
Rows per page, between 1 and 500. Page through with
cursor.series_key, title, country and country_name, category, frequency, unit, seasonal_adj, the concept tags, revision_history, release_dates_tracked, release_dates_from, period_semantics, and a coverage block with the first and last period, the last release date and the observation count.
GET /v1/macro/series/{series_key}
The values of one series, newest period first. The response carries the same series block as search, thendata rows of period_date, value and released_on.
period_date is the period the number describes: the first day of the month or quarter, the observation day for daily rates, or the day a change took effect for EVENT series — the row’s period_semantics says which. value is in the series’ unit.
string
default:"current"
current returns one row per period with the figure as it stands today. first_release returns what was published first. vintages returns every revision, one row per release.string
Point in time,
YYYY-MM-DD: only releases on or before this day count, and each period shows the newest of those. Must be on or after the series’ release_dates_from; earlier dates return a 400.string
Earliest
period_date, YYYY-MM-DD. date_lte sets the ceiling.integer
default:"200"
Rows per page, between 1 and 1000. Page through with
cursor.404 with the advice to search first — not an empty page.
GET /v1/macro/catalog
Whether a series exists anywhere: the FRED® and World Bank indices, titles only, withingested saying whether we serve it. Free. An entry with ingested: false is a series that can be added on request; an entry with ingested: true carries our series_key.
string
Words to match in the title, for example
manufacturing orders germany.string
Restrict to a frequency,
D to A.boolean
true for entries we already serve, false for entries we do not.integer
default:"50"
Rows per page, between 1 and 500. Page through with
cursor.