macro tool

Public

macro_search_series

Resolve a macro topic to ranked series in our catalog.

Description

Resolve a macro topic to ranked series in our catalog.

Covers Treasury, BLS, BEA, ECB policy/€STR/euro-area yield curves, Federal Reserve Board H.15/PRATES rates, H.4.1 balance-sheet levels, H.8 bank credit and deposits, G.17/G.19 activity and credit, SLOOS lending standards and loan demand, USAspending obligations, plus Eurostat HICP, GDP growth, and unemployment.

The result is the shared envelope: data.query echoes the search and data.matches is the ranked list (best first); meta holds source ("macro_catalog") and the freshest match as_of; pagination is null — this is a bounded relevance list, not a paged one, so refine the query for better matches rather than expecting to page.

Each match carries the series_key (pass it to macro_get_series), source (treasury/bls/bea/ecb/frb/usaspending/eurostat), title, units, currency (null for dimensionless series like percents/indices), frequency (dailyannual), seasonal_adjustment, geography, a score in [0, 1], and a match_reason (series_key, title, or keyword) so you can see why a candidate ranked where it did. Note that each native frequency is its own series (a quarterly and an annual GDP cut are two keys) — pick the frequency you want here rather than expecting one series to downsample. An empty/whitespace query returns no matches (a normal, empty success — not an error).

Parameters

Input schema

NameTypeRequiredDefaultDescription
querystringYesFree-form topic search over the curated macro catalog: a concept ('10-year treasury yield', 'core CPI', 'federal funds target range'), a series-key fragment ('cpi', 'treasury_yield', 'fed_funds'), or a single word ('unemployment'). Call this FIRST when you have a topic rather than an exact series_key, then pass a match's `series_key` to macro_get_series.
limitintegerNo10Max ranked matches to return (1–50).

Provenance

Sources

  • beaU.S. Bureau of Economic Analysis
  • blsU.S. Bureau of Labor Statistics
  • ecbEuropean Central Bank
  • eurostatEurostat
  • frbBoard of Governors of the Federal Reserve System
  • macro_catalogCurated internal catalog (Treasury, BLS, BEA, FRB, USAspending, Eurostat)
  • treasuryU.S. Department of the Treasury
  • usaspendingU.S. Department of the Treasury, USAspending.gov

Dataset registry: macro_bea, macro_bls, macro_ecb, macro_eurostat, macro_frb, macro_treasury, macro_usaspending