Economic series
Discover macro, Treasury curves, reference rates, funding/credit spreads, FX reference, commodity and housing series in one catalog. Coverage: US Federal Reserve data (Treasury constant-maturity yields, SOFR, EFFR, OBFR and TGCR with percentiles and volumes, BGCR, SOFR averages and index, Fed target range, IORB, CPI, PCE, labor, inflation expectations, commercial paper); the U.S. Treasury's daily bill rates, extra par curve tenors, real par yields and long-term rates; SONIA, the euro short-term rate (ESTR) and ECB and Bank of England policy rates; US funding spreads; the NY Fed corporate bond market distress index, the Treasury HQM corporate yield curve and CFTC CDS notionals; annual sovereign risk premiums, equity risk premiums, corporate tax rates and CDS spreads by country and default spreads by rating (world.sovereign_default_spread.{rating}); closing benchmark government bond yields of about 60 countries (yields, ID {country}.government_bond.yield.{tenor}); EURIBOR, euro swap and Canadian prime rates; ECB euro reference and Norges Bank exchange rates (fx); World Bank development indicators for about 50 economies and aggregates (ID {country}.wdi.{indicator}, annual); energy, metal and agricultural prices and commodity price indices (commodity); and BIS residential property price indices (real_estate). Each series names its original publisher; country series carry country_code, and aggregates (euro area, world, groups of economies) a null country_code and their region. Money is in currency_code units: commodity prices in US dollars per the unit the name states, exchange rates in units of currency_code per one unit of the named currency. Default order: id ascending. Results are limited to the entitled scope. Data is delivered from validated canonical batches; a connected dataset with nothing published for the key's markets yet returns 503. Access requires the operation capability on the API key.
/v1/economic/series- Required capability
- economic.read
- Data timing
- As released
- Credits
- 5 credits per request.
Parameters
countriesstringoptional · query- ISO 3166-1 alpha-2 country codes.
categorystringoptional · query- Series category.
economyratesyieldscreditfxcommodityreal_estate qstringoptional · query- Case-insensitive series name search. A value that is empty or only whitespace returns 422.
as_ofstringoptional · query- Knowledge cutoff as a UTC date (YYYY-MM-DD): the response reflects what was known by the end of that day. Defaults to now; cannot be in the future. A date from before the dataset's knowledge history returns 422 point-in-time-unavailable naming the earliest one, which GET /v1/datasets lists as earliest_as_of.
known_fromstringoptional · query- First UTC date (YYYY-MM-DD, inclusive) on which a revision became known.
known_tostringoptional · query- Last UTC date (YYYY-MM-DD, inclusive) on which a revision became known; on or after known_from.
orderstringoptional · query- Direction on id; ties use ID ascending.
Default:ascdescasc limitintegeroptional · query- Maximum records per page.Default:
100 cursorstringoptional · query- Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.
formatstringoptional · query- Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.
jsoncsv
Response fields
Returns data as an array of records. All example values are illustrative.
idstring- Stable series ID.
namestring- Series display name.
categorystring- Economic dataset family.
economyratesyieldscreditfxcommodityreal_estate country_codestring · null- country code
regionstring · null- Geographic region.
frequencystring- Observation frequency.
dailyweeklymonthlyquarterlyannualirregular unitstring- Declared unit, including scale.
currency_codestring · null- ISO 4217 currency. Crypto quote assets use instrument IDs, not invented ISO codes.
seasonal_adjustmentstring- Seasonal adjustment.
adjustedunadjustednot_applicableunknown maturitystring · null- Tenor for yield/credit series, ISO 8601 duration.
publisherstring · null- Agency that compiles and first publishes the series.
Response metadata
Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.
When something goes wrong
An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.
Plans
Requires economic.read. Access, recency and history depth come from the plan definitions the API enforces.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Not included | — | — |
| Developer | Not included | — | — |
| Pro | Included | As released | Not date-bounded |
| Commercial | Included | As released | Not date-bounded |
| Scale | Included | As released | Not date-bounded |
History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans