Skip to main content
Glama
Finance Toolkit

Finance Toolkit

macroeconomics

Read-onlyIdempotent

Retrieve and compare country-level GDP, inflation, trade, confidence, and debt indicators to assess economic conditions and trends.

Instructions

Macroeconomic indicators by country (GDP, real GDP, CPI, PPI, export and import price indices, inflation rate, trade balance, imports, exports, investment, consumption, business/consumer confidence, house prices, rent prices, exchange rates, real effective exchange rate, money supply, household savings rate, household debt-to-income ratio, output gap, real interest rate, misery index, banking/currency/sovereign debt crisis indicators, commercial real estate prices, credit-to-GDP gap, debt service ratios, credit to GDP by sector, commodity forward curves). Requires countries='United States' — use comma-separated values for multiple countries. Do NOT use tickers= for this tool. Supports start_date/end_date. Indicators with a period come at the highest frequency they are published at unless period= says otherwise (daily, else weekly, monthly, quarterly, yearly); house prices, rent prices, the household savings rate and the household debt-to-income ratio come quarterly from the OECD (quarterly=false for yearly); get_real_interest_rate is monthly (period='yearly' for annual), the nominal rate minus inflation with rate_type='long_term' (default), 'short_term' or 'policy' (the central bank rate, incl. 'Euro Area'); the others are yearly. quarterly=true returns quarterly data only where a source has it (a note says when it does not). Supports rolling=N (moving-average smoothing) and trailing=N (trailing N-period sum, e.g. a trailing-4-quarter sum) on the raw series. get_gross_domestic_product_growth returns the latest quarterly real GDP growth (quarter on quarter, or year_over_year=true). get_shiller_stock_market_data returns Robert Shiller's monthly US stock market data from 1871 (price, dividend, earnings, CPI, long rate, CAPE; no countries needed). get_supply_chain_pressure_index returns the New York Fed's Global Supply Chain Pressure Index, monthly from 1998, in standard deviations from its average (not a decimal; a 'World' column, no countries needed). get_exchange_rates returns each country's currency per US dollar (e.g. countries='Japan' for yen per dollar, not a currency pair; for a pair such as EURUSD use the market_data tool with tickers='EURUSD'), defaults to daily rates and accepts end_of_period=true for month-, quarter- or year-end rates (BIS, about a week behind). For the change of currencies against the dollar up to the latest close, use the market_data tool with tickers quoted in dollars ('EURUSD,GBPUSD,JPYUSD,CNYUSD,CHFUSD') and their Cumulative Return. get_commercial_real_estate_prices covers around twenty economies (BIS). get_credit_to_gdp_gap (the Basel III credit gap), get_debt_service_ratio and get_credit_to_gdp_ratio come quarterly from the BIS, for around 45, 30 and 45 economies; borrowers='private' (default), 'households' or 'corporations' selects the sector (get_credit_to_gdp_ratio also 'government' and 'non_financial'). get_inflation_rate and get_consumer_price_index default to monthly data (period='yearly' for annual) (sources: Eurostat incl. the euro area flash estimate, the ONS for the United Kingdom, the Statistics Bureau of Japan, and the BIS for around sixty other countries incl. the United States, China, India and Brazil; the US months the BLS has released since the latest BIS update are added, so a CPI release appears the same day). measure='core' (all items less food and energy) or a component, 'energy', 'food', 'goods', 'services' or 'shelter' (US only), returns those monthly for the United States (BLS CPI-U, not seasonally adjusted; about the last three years without a FRED key) and the euro area and European countries (Eurostat HICP). get_consumer_price_index also accepts oecd_source=true for monthly/quarterly OECD data only. get_consumer_price_index with cumulative=true returns the growth of 1 in prices since the first period of the date range (1.346 for prices 34.6% higher). get_purchasing_power returns what 100 at start_date buys in every later month, in start_date prices (100 × CPI(start) / CPI(t), e.g. 74.29 when prices rose 34.6%; period='yearly' for annual averages); overnight_rate=true deposits the 100 at the currency's overnight rate compounded daily (€STR for the Euro Area and its members, SONIA, TONA, SOFR; monthly only), the real value of cash, with countries without an overnight rate left out with a note; each month's cash value is paired with that same month's CPI, so months whose CPI is not yet published are left out. get_producer_price_index, get_export_price_index and get_import_price_index return monthly indices (period='quarterly' or 'yearly' for averages) from the official publishers: Eurostat for the euro area, the EU and around 35 European countries, the BLS for the United States (about the last three years without a FRED key) and the Bank of Japan; growth=true with lag=12 gives the year-on-year change. China has no producer price index there: get_economic_calendar with countries='China' and events='Producer Price' has its monthly year-on-year release. get_commodity_prices returns the World Bank's monthly average prices in US dollars from 1960 (the Pink Sheet, no countries needed): commodity= e.g. 'Gold', 'Crude oil Brent', 'Crude oil WTI', 'Copper', 'Natural gas Europe' (the World Bank's names without commas, about seventy; all when left out), in $/troy oz for precious metals, $/bbl for oil, $/mmbtu for gas and $/mt for base metals and grains; deflate_with='United States' gives real prices in the money of the latest month of that country's CPI up to end_date (e.g. gold in 1980 against today's), and econometrics takes the same with series='macroeconomics:get_commodity_prices:Gold' and deflate_with='United States' (e.g. get_level_significance with level= for the first month above the 1980 peak). get_chokepoint_transits returns IMF PortWatch's daily ship transits through 28 maritime chokepoints from 2019 (no countries needed): chokepoints= e.g. 'Strait of Hormuz,Suez Canal,Bab el-Mandeb Strait,Cape of Good Hope,Panama Canal' (a part such as 'Hormuz' works; all when left out), a column per ship category (Container, Dry Bulk, General Cargo, Ro-Ro, Tanker, Cargo = all but tankers, Total) and per chokepoint when there are several; show_columns='Tanker' keeps one category. measure='transits' (number of ships, default) or 'trade_volume' (estimated cargo in metric tons); period='weekly', 'monthly', 'quarterly' or 'yearly' sums the days (complete periods only). Updated weekly; days are UTC. get_commodity_forward_curve and get_commodity_term_structure take commodity= instead of countries= ('Crude Oil', 'Natural Gas', 'Gold', 'Silver', 'Copper', 'Corn', 'Wheat' or 'Soybeans', comma-separated for several; all eight when left out). get_commodity_forward_curve returns the daily settlement of each dated futures contract listed today (columns are delivery months, e.g. '2026-12'); generic=true returns the generic (nearby) curve as it stood each day instead (Front, +1, ... +11: positions ranked per day, rolling at each contract's last trading day, not interpolated to fixed maturities), and growth=true with lag=N the change of each column over N trading days. get_commodity_term_structure returns per day the front and the far contract (the last of the 12-month strip starting with the front, e.g. Dec26 against Nov27), their prices, the Spread (front minus far, positive in backwardation), the Slope (far / front - 1, a decimal), the annualised Roll Yield (ln(front / far) x 12 / months, a decimal) and Structure ('Backwardation', 'Contango' or 'Flat'); its time series gives the widest spread directly. Yahoo Finance drops a contract once it expires, so on a past date the positions (and the term structure) whose contract has expired since are empty; generic=false on get_commodity_term_structure compares today's front and far contract over their full history instead. Also includes five US-only indicators that only return a 'United States' column regardless of the countries= argument: get_industrial_production_index (Federal Reserve G.17), get_recession_indicator (NBER business cycle dates), get_retail_sales (Census Bureau, monthly from 1992), get_housing_starts (Census Bureau, monthly from 1959) and get_real_personal_income (BEA, monthly from 1959). get_economic_calendar returns scheduled economic data releases (event, previous, estimate, actual, impact) rather than a country series. By default it returns only High impact releases from the past 23 days to the coming 7 days; narrow it with countries= (e.g. 'United States') and currencies= (e.g. 'USD,EUR'), filter on event names with events= (e.g. events='PMI' for the purchasing managers' indices with consensus, or 'CPI,Unemployment'), pass impact='Medium' or 'High,Medium' for more, impact='All' for every release, and start_date/end_date for another window (keep it to a few weeks: one month of every country is over 2,000 releases). Its Unit column gives each release's unit; releases quoted in percent and its Change % column are decimals like the rest. as_series=true returns the Actual of every event by the period it covers instead of the releases by date (read from the event name: the month, quarter or year; a December figure released in January belongs to the previous year), a column per event and its consensus as ' Estimate', keeping the latest release of a period (the final figure after a flash); the default impact is High, so pass impact='All' to include Medium and Low releases. In the econometrics tool, series='macroeconomics:get_economic_calendar:China:Producer Price Index YoY' reads one such event as a series (the event name without its period as the column), every impact included; a figure published for two months at once, such as China's January and February trade, is kept once under the later month. The calendar starts in 2013 for most countries. Its Currency column is the currency of the market a release concerns, not of its value (China's balance of trade is in US dollars). Every rate and ratio this tool returns is a decimal fraction, not a percentage: an inflation rate of 4.1% comes back as 0.0412 and a debt-to-GDP ratio of 131.7% as 1.3173. Multiply by 100 before presenting them as percentages. Global Macro Database options: usd=true returns GDP, GDP per capita, consumption, investment, fixed investment, exports, imports, trade balance and current account in millions of US dollars (comparable across countries); get_total_consumption and get_total_consumption_to_gdp_ratio accept component='total', 'household' or 'government'; get_gross_domestic_product with inflation_adjusted=true returns real GDP (with usd=true in millions of US dollars at constant 2015 prices) and get_house_prices with inflation_adjusted=true real house prices. Yearly GMDB series end at the last observation; pass gmdb_forecasts=true to include the IMF projections up to five years ahead. get_implied_volatility returns volatility indices by market and maturity as decimals, no countries needed (markets='US Equity' VIX 9D-1Y from 1990, 'Euro Area Equity' VSTOXX 1M-24M from 1999, 'Emerging Markets Equity', 'US Equity Volatility' VVIX, 'US Treasury Bonds' VXTLT, 'Crude Oil', 'Gold'; with an FMP key also 'US Treasury Rates' MOVE and 'Japan Government Bonds'), period='daily', 'weekly' or 'monthly'. get_stress_test_scenario returns regulators' stress test scenarios (authority='federal_reserve' quarterly US and international variables incl. Treasury and BBB yields, equity, house prices and VIX; authority='esrb' the EBA bank stress test, yearly, every EU country plus iTraxx spreads), scenario='baseline', 'adverse' or 'historic' (Fed history from 1976), countries= optional; the scenario path is not cut to start_date/end_date. Long-horizon data: get_long_run_asset_returns returns yearly total returns 1870-2020 for 18 advanced economies (Jordà-Schularick-Taylor; asset_class='equity'|'housing'|'bonds'|'bills'|'risky'|'safe'|'wealth', real=true for real returns; licensed for non-commercial use only, so it requires accept_licence=true; countries= optional). get_millennium_of_macroeconomic_data returns the Bank of England's annual UK series from as early as 1086 to 2016 (series= e.g. 'Bank Rate,Consols,Share prices'; set start_date far back, e.g. 1700-01-01). deflate_with='United States' puts a money series in today's dollars (the latest year of that country's CPI), e.g. series='$ Oil prices'; growth=true with lag= gives the change over lag years. get_scenario_set returns De Nederlandsche Bank's pension scenario set (20,000 scenarios over 100 years, measure='real_world' or 'market_consistent'): quantiles per horizon year of nominal zero rates 1Y-30Y, the euro area 10Y real rate, equity returns and EU/NL inflation; the first call takes one to two minutes. get_asset_class_proxies returns daily total returns of listed funds tracking private equity, infrastructure, hedge funds, merger arbitrage, private credit, real estate and investment grade and high yield credit (asset_classes=, period='daily'|'weekly'|'monthly').

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "indicator": "<indicator>"
    },
    "name": "macroeconomics"
  }
}

Input Schema

NameRequiredDescriptionDefault
lagNoNumber of periods to lag when computing growth rates.
usdNoReturn levels in millions of US dollars instead of national currency when True, which makes them comparable across countries (Global Macro Database).
rankNotrue ranks the tickers (or countries) within every period, from the highest value (rank 1) to the lowest, and compares each with its neighbour toward the middle of the ranking: the Difference (in points for returns) and the Multiple (only when both have the same sign), so the first and last rank show how far the best and the worst stand apart, e.g. a fall more than twice as large as the next one. Needs a value per period and ticker; pick one field with show_columns where there are more.
realNoWhether to deflate the returns by consumer price inflation.
yearNoThe year of the Federal Reserve's stress test, from 2025.
limitNoThe rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead, and rows per ticker (an earnings calendar) are selected per ticker. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row.
eventsNoParts of event names to keep, matched without regard to case, e.g. "PMI" for every purchasing managers' index or ["CPI", "Unemployment"].
growthNoReturn period-over-period growth rates instead of absolute values.
impactNoThe market impact to keep: "Low", "Medium" and/or "High", or "All" for every release. Leave unset to use the default of the indicator you selected. Defaults are 'High' for get_economic_calendar.
periodNoObservation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_export_price_index, get_import_price_index, get_inflation_rate, get_producer_price_index, get_purchasing_power, get_real_interest_rate, get_share_prices; 'daily' for get_asset_class_proxies, get_chokepoint_transits, get_implied_volatility.
seriesNoAnalyze the indicators of other tools instead of the tickers' prices: references separated by ';', each tool:indicator:tickers-or-countries with an optional :column, e.g. 'valuation:get_price_to_earnings_ratio:AAPL,MSFT; macroeconomics:get_inflation_rate:United States' or 'rates:get_government_bond_yield_curve:United States,Germany:10Y'. Every ticker or country becomes a series named after it, which dependent_ticker and independent_tickers then name. Use start_date for a long enough history.
genericNoFor get_commodity_forward_curve: Whether the columns are the positions on each day's curve (Front, +1, +2, ...) instead of the contracts listed today. For get_commodity_term_structure: Whether the front and far contract are those of each day's curve, instead of today's. Leave unset to use the default of the indicator you selected. Defaults are False for get_commodity_forward_curve; True for get_commodity_term_structure.
marketsNoThe markets to retrieve, from "US Equity", "Euro Area Equity", "Emerging Markets Equity", "US Equity Volatility", "US Treasury Bonds", "Crude Oil", "Gold", "US Treasury Rates" and "Japan Government Bonds".
measureNoSub-measure selector, e.g. 'M1', 'M2', or 'M3' for money supply. Leave unset to use the default of the indicator you selected. Defaults are 'all' for get_consumer_price_index, get_inflation_rate; None for get_money_supply; 'real_world' for get_scenario_set; 'transits' for get_chokepoint_transits.
returnsNoWhether to return the total return per period instead of the dividend-adjusted price.
rollingNoRolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series.
end_dateNoEnd of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window).
scenarioNo"baseline", "adverse" (the Federal Reserve's severely adverse scenario) or "historic".adverse
trailingNoTrailing window size in number of periods. Sums the raw values over the trailing N periods (e.g. trailing=4 on quarterly data gives a trailing-4-quarter / TTM-style sum) instead of returning one value per period.
as_seriesNoWhether to return the Actual and Estimate of every event as time series by the period they cover, with (Country, Event) columns, instead of the releases by date.
authorityNoFor get_stress_test_scenario: "federal_reserve" or "esrb". For get_scenario_set: The regulator: "dnb". Leave unset to use the default of the indicator you selected. Defaults are 'dnb' for get_scenario_set; 'federal_reserve' for get_stress_test_scenario.
borrowersNoFor get_debt_service_ratio: The borrowing sector: "private" (households and non-financial corporations together), "households" or "corporations" (non-financial corporations). For get_credit_to_gdp_ratio: The borrowing sector: "private" (households and non-financial corporations), "households", "corporations" (non-financial corporations), "government" (at nominal value) or "non_financial" (all three together).private
commodityNoFor get_commodity_forward_curve: The commodity, or a list of them, to retrieve the curve for: "Crude Oil", "Natural Gas", "Gold", "Silver", "Copper", "Corn", "Wheat" or "Soybeans". For get_commodity_prices: The commodities, e.g. "Gold" or ["Gold", "Crude oil Brent"], as named by the World Bank without commas ("Crude oil, Brent" is "Crude oil Brent"), in any casing. For get_commodity_term_structure: The commodity, or a list of.
componentNoPart of final consumption: 'total', 'household' or 'government'.total
contractsNoThe number of contracts to return, the nearest listed ones from the current month on, or with generic the number of positions (the front included).
countriesNoCountry names, comma-separated or as a list, e.g. 'United States,Germany,Japan'.
indicatorYesName of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name.
quantilesNoThe quantiles of the distribution per year.
quarterlyNoReturn quarterly data instead of annual when True.
rate_typeNoWhich nominal interest rate to use. Can be 'long_term' (10-year government bond yield), 'short_term' (3-month money market rate) or 'policy' (central bank policy rate).long_term
scenariosNoWhether to return every scenario instead of the distribution.
variablesNoThe variables to include, from "Nominal rate 1Y", "Nominal rate 5Y", "Nominal rate 10Y", "Nominal rate 20Y", "Nominal rate 30Y", "Real rate EU 10Y", "Equity return", "Inflation EU" and "Inflation NL".
cumulativeNoReturn the cumulative value compounded over time instead of the discrete value per period. Always rebased to start at 1 at the beginning of the selected date range.
currenciesNoThe currencies to keep, e.g. "USD" or ["USD", "EUR"].
start_dateNoStart of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window).
asset_classNo"equity", "housing", "bonds", "bills", "risky", "safe" or "wealth".equity
chokepointsNoThe chokepoints, e.g. "Strait of Hormuz" or ["Suez Canal", "Cape of Good Hope"], in any casing; a part of a name that identifies one chokepoint, such as "Hormuz" or "Suez", works too.
gmdb_sourceNoUse the Global Macro Database as the data source when True, rather than the OECD. The two are independent providers with different country and period coverage; both return rates and ratios as decimal fractions.
oecd_sourceNoWhether to get the data from the OECD instead of the Global Macro Database (GMDB).
standardizeNoReturn the Z-Score (standard score) instead of the raw values, i.e. how many standard deviations each value is from the mean of its own series. When combined with growth=True, the growth values are standardized instead of the raw values.
deflate_withNoWith series: the country whose consumer price index the indicators that take deflate_with are deflated with, e.g. 'United States' for 'macroeconomics:get_commodity_prices:Gold' in real terms.
show_columnsNoComma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage.
asset_classesNoThe asset classes to include, from "Private Equity", "Infrastructure", "Hedge Funds", "Merger Arbitrage", "Private Credit", "Real Estate", "Investment Grade Credit" and "High Yield Credit".
end_of_periodNoWhether to return the rate at the end of each month, quarter or year instead of its average.
accept_licenceNoConfirms that the data is used for non-commercial purposes, as its licence (CC BY-NC-SA 4.0) requires.
gmdb_forecastsNoSet to true to include the years the Global Macro Database projects (IMF World Economic Outlook, up to five years ahead); by default a yearly series ends with its last observation.
overnight_rateNoWhether the 100 earns the overnight rate of its currency instead of being held as banknotes.
year_over_yearNoWhether to return the change on the same quarter a year earlier instead of on the previous quarter.
inflation_adjustedNoAdjust nominal values for inflation when True.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv2.3.4
    • addedInput schema / properties / as_series
      Added value: +{
      +  "default": false,
      +  "description": "Whether to return the Actual and Estimate of every event as time series by the period they cover, with (Country, Event) columns, instead of the releases by date.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / chokepoints
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The chokepoints, e.g. \"Strait of Hormuz\" or [\"Suez Canal\", \"Cape of Good Hope\"], in any casing; a part of a name that identifies one chokepoint, such as \"Hormuz\" or \"Suez\", works too."
      +}
    • changedInput schema / properties / commodity / description
      Previous value: -"For get_commodity_forward_curve: The commodity, or a list of them, to retrieve the curve for: \"Crude Oil\", \"Natural Gas\", \"Gold\", \"Silver\", \"Copper\", \"Corn\", \"Wheat\" or \"Soybeans\". For get_commodity_term_structure: The commodity, or a list of."New value: +"For get_commodity_forward_curve: The commodity, or a list of them, to retrieve the curve for: \"Crude Oil\", \"Natural Gas\", \"Gold\", \"Silver\", \"Copper\", \"Corn\", \"Wheat\" or \"Soybeans\". For get_commodity_prices: The commodities, e.g. \"Gold\" or [\"Gold\", \"Crude oil Brent\"], as named by the World Bank without commas (\"Crude oil, Brent\" is \"Crude oil Brent\"), in any casing. For get_commodity_term_structure: The commodity, or a list of."
    • addedInput schema / properties / cumulative
      Added value: +{
      +  "default": false,
      +  "description": "Return the cumulative value compounded over time instead of the discrete value per period. Always rebased to start at 1 at the beginning of the selected date range.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / deflate_with
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "With series: the country whose consumer price index the indicators that take deflate_with are deflated with, e.g. 'United States' for 'macroeconomics:get_commodity_prices:Gold' in real terms."
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_business_confidence_index",
      -  "get_composite_leading_indicator",
      -  "get_consumer_confidence_index",
      -  "get_consumer_price_index",
      -  "get_current_account_balance",
      -  "get_current_account_balance_to_gdp_ratio",
      -  "get_exchange_rates",
      -  "get_exports",
      -  "get_exports_to_gdp_ratio",
      -  "get_fixed_investment",
      -  "get_fixed_investment_to_gdp_ratio",
      -  "get_gross_domestic_product",
      -  "get_gross_domestic_product_deflator",
      -  "get_gross_domestic_product_growth",
      -  "get_shiller_stock_market_data",
      -  "get_supply_chain_pressure_index",
      -  "get_house_prices",
      -  "get_imports",
      -  "get_imports_to_gdp_ratio",
      -  "get_inflation_rate",
      -  "get_investment",
      -  "get_investment_to_gdp_ratio",
      -  "get_money_supply",
      -  "get_producer_price_index",
      -  "get_rent_prices",
      -  "get_share_prices",
      -  "get_total_consumption",
      -  "get_total_consumption_to_gdp_ratio",
      -  "get_household_savings_rate",
      -  "get_household_debt_to_income_ratio",
      -  "get_retail_sales",
      -  "get_industrial_production_index",
      -  "get_housing_starts",
      -  "get_real_personal_income",
      -  "get_recession_indicator",
      -  "get_commercial_real_estate_prices",
      -  "get_credit_to_gdp_gap",
      -  "get_debt_service_ratio",
      -  "get_credit_to_gdp_ratio",
      -  "get_commodity_forward_curve",
      -  "get_commodity_term_structure",
      -  "get_output_gap",
      -  "get_real_interest_rate",
      -  "get_real_effective_exchange_rate",
      -  "get_misery_index",
      -  "get_banking_crisis",
      -  "get_currency_crisis",
      -  "get_sovereign_debt_crisis",
      -  "get_real_gross_domestic_product_per_capita",
      -  "get_trade_balance",
      -  "get_implied_volatility",
      -  "get_stress_test_scenario",
      -  "get_long_run_asset_returns",
      -  "get_millennium_of_macroeconomic_data",
      -  "get_scenario_set",
      -  "get_asset_class_proxies",
      -  "get_economic_calendar"
      -]New value: +[
      +  "get_business_confidence_index",
      +  "get_composite_leading_indicator",
      +  "get_consumer_confidence_index",
      +  "get_consumer_price_index",
      +  "get_current_account_balance",
      +  "get_current_account_balance_to_gdp_ratio",
      +  "get_exchange_rates",
      +  "get_exports",
      +  "get_exports_to_gdp_ratio",
      +  "get_fixed_investment",
      +  "get_fixed_investment_to_gdp_ratio",
      +  "get_gross_domestic_product",
      +  "get_gross_domestic_product_deflator",
      +  "get_gross_domestic_product_growth",
      +  "get_shiller_stock_market_data",
      +  "get_supply_chain_pressure_index",
      +  "get_house_prices",
      +  "get_imports",
      +  "get_imports_to_gdp_ratio",
      +  "get_inflation_rate",
      +  "get_purchasing_power",
      +  "get_investment",
      +  "get_investment_to_gdp_ratio",
      +  "get_money_supply",
      +  "get_producer_price_index",
      +  "get_export_price_index",
      +  "get_import_price_index",
      +  "get_rent_prices",
      +  "get_share_prices",
      +  "get_total_consumption",
      +  "get_total_consumption_to_gdp_ratio",
      +  "get_household_savings_rate",
      +  "get_household_debt_to_income_ratio",
      +  "get_retail_sales",
      +  "get_industrial_production_index",
      +  "get_housing_starts",
      +  "get_real_personal_income",
      +  "get_recession_indicator",
      +  "get_commercial_real_estate_prices",
      +  "get_credit_to_gdp_gap",
      +  "get_debt_service_ratio",
      +  "get_credit_to_gdp_ratio",
      +  "get_commodity_forward_curve",
      +  "get_commodity_prices",
      +  "get_chokepoint_transits",
      +  "get_commodity_term_structure",
      +  "get_output_gap",
      +  "get_real_interest_rate",
      +  "get_real_effective_exchange_rate",
      +  "get_misery_index",
      +  "get_banking_crisis",
      +  "get_currency_crisis",
      +  "get_sovereign_debt_crisis",
      +  "get_real_gross_domestic_product_per_capita",
      +  "get_trade_balance",
      +  "get_implied_volatility",
      +  "get_stress_test_scenario",
      +  "get_long_run_asset_returns",
      +  "get_millennium_of_macroeconomic_data",
      +  "get_scenario_set",
      +  "get_asset_class_proxies",
      +  "get_economic_calendar"
      +]
    • changedInput schema / properties / measure / description
      Previous value: -"Sub-measure selector, e.g. 'M1', 'M2', or 'M3' for money supply. Leave unset to use the default of the indicator you selected. Defaults are None for get_money_supply; 'real_world' for get_scenario_set."New value: +"Sub-measure selector, e.g. 'M1', 'M2', or 'M3' for money supply. Leave unset to use the default of the indicator you selected. Defaults are 'all' for get_consumer_price_index, get_inflation_rate; None for get_money_supply; 'real_world' for get_scenario_set; 'transits' for get_chokepoint_transits."
    • addedInput schema / properties / overnight_rate
      Added value: +{
      +  "default": false,
      +  "description": "Whether the 100 earns the overnight rate of its currency instead of being held as banknotes.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / period / description
      Previous value: -"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_inflation_rate, get_producer_price_index, get_share_prices; 'daily' for get_asset_class_proxies, get_implied_volatility."New value: +"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_export_price_index, get_import_price_index, get_inflation_rate, get_producer_price_index, get_purchasing_power, get_real_interest_rate, get_share_prices; 'daily' for get_asset_class_proxies, get_chokepoint_transits, get_implied_volatility."
    • addedInput schema / properties / rank
      Added value: +{
      +  "default": false,
      +  "description": "true ranks the tickers (or countries) within every period, from the highest value (rank 1) to the lowest, and compares each with its neighbour toward the middle of the ranking: the Difference (in points for returns) and the Multiple (only when both have the same sign), so the first and last rank show how far the best and the worst stand apart, e.g. a fall more than twice as large as the next one. Needs a value per period and ticker; pick one field with show_columns where there are more.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / rate_type / description
      Previous value: -"Which nominal interest rate to use. Can be 'long_term' (10-year government bond yield) or 'short_term' (3-month money market rate)."New value: +"Which nominal interest rate to use. Can be 'long_term' (10-year government bond yield), 'short_term' (3-month money market rate) or 'policy' (central bank policy rate)."
  2. Changed6 schema fields changedv2.3.3
    • changedInput schema / properties / commodity / description
      Previous value: -"The commodity to retrieve the curve for. One of \"Crude Oil\", \"Natural Gas\", \"Gold\", \"Silver\", \"Copper\", \"Corn\", \"Wheat\" or \"Soybeans\". Leave unset to use the default of the indicator you selected. Required by: get_commodity_forward_curve."New value: +"For get_commodity_forward_curve: The commodity, or a list of them, to retrieve the curve for: \"Crude Oil\", \"Natural Gas\", \"Gold\", \"Silver\", \"Copper\", \"Corn\", \"Wheat\" or \"Soybeans\". For get_commodity_term_structure: The commodity, or a list of."
    • changedInput schema / properties / contracts / description
      Previous value: -"The number of contracts to return, the nearest listed ones from the current month on."New value: +"The number of contracts to return, the nearest listed ones from the current month on, or with generic the number of positions (the front included)."
    • addedInput schema / properties / generic
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "For get_commodity_forward_curve: Whether the columns are the positions on each day's curve (Front, +1, +2, ...) instead of the contracts listed today. For get_commodity_term_structure: Whether the front and far contract are those of each day's curve, instead of today's. Leave unset to use the default of the indicator you selected. Defaults are False for get_commodity_forward_curve; True for get_commodity_term_structure."
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_business_confidence_index",
      -  "get_composite_leading_indicator",
      -  "get_consumer_confidence_index",
      -  "get_consumer_price_index",
      -  "get_current_account_balance",
      -  "get_current_account_balance_to_gdp_ratio",
      -  "get_exchange_rates",
      -  "get_exports",
      -  "get_exports_to_gdp_ratio",
      -  "get_fixed_investment",
      -  "get_fixed_investment_to_gdp_ratio",
      -  "get_gross_domestic_product",
      -  "get_gross_domestic_product_deflator",
      -  "get_gross_domestic_product_growth",
      -  "get_shiller_stock_market_data",
      -  "get_supply_chain_pressure_index",
      -  "get_house_prices",
      -  "get_imports",
      -  "get_imports_to_gdp_ratio",
      -  "get_inflation_rate",
      -  "get_investment",
      -  "get_investment_to_gdp_ratio",
      -  "get_money_supply",
      -  "get_producer_price_index",
      -  "get_rent_prices",
      -  "get_share_prices",
      -  "get_total_consumption",
      -  "get_total_consumption_to_gdp_ratio",
      -  "get_household_savings_rate",
      -  "get_household_debt_to_income_ratio",
      -  "get_retail_sales",
      -  "get_industrial_production_index",
      -  "get_housing_starts",
      -  "get_real_personal_income",
      -  "get_recession_indicator",
      -  "get_commercial_real_estate_prices",
      -  "get_credit_to_gdp_gap",
      -  "get_debt_service_ratio",
      -  "get_credit_to_gdp_ratio",
      -  "get_commodity_forward_curve",
      -  "get_output_gap",
      -  "get_real_interest_rate",
      -  "get_real_effective_exchange_rate",
      -  "get_misery_index",
      -  "get_banking_crisis",
      -  "get_currency_crisis",
      -  "get_sovereign_debt_crisis",
      -  "get_real_gross_domestic_product_usd",
      -  "get_real_gross_domestic_product_per_capita",
      -  "get_trade_balance",
      -  "get_implied_volatility",
      -  "get_stress_test_scenario",
      -  "get_long_run_asset_returns",
      -  "get_millennium_of_macroeconomic_data",
      -  "get_scenario_set",
      -  "get_asset_class_proxies",
      -  "get_economic_calendar"
      -]New value: +[
      +  "get_business_confidence_index",
      +  "get_composite_leading_indicator",
      +  "get_consumer_confidence_index",
      +  "get_consumer_price_index",
      +  "get_current_account_balance",
      +  "get_current_account_balance_to_gdp_ratio",
      +  "get_exchange_rates",
      +  "get_exports",
      +  "get_exports_to_gdp_ratio",
      +  "get_fixed_investment",
      +  "get_fixed_investment_to_gdp_ratio",
      +  "get_gross_domestic_product",
      +  "get_gross_domestic_product_deflator",
      +  "get_gross_domestic_product_growth",
      +  "get_shiller_stock_market_data",
      +  "get_supply_chain_pressure_index",
      +  "get_house_prices",
      +  "get_imports",
      +  "get_imports_to_gdp_ratio",
      +  "get_inflation_rate",
      +  "get_investment",
      +  "get_investment_to_gdp_ratio",
      +  "get_money_supply",
      +  "get_producer_price_index",
      +  "get_rent_prices",
      +  "get_share_prices",
      +  "get_total_consumption",
      +  "get_total_consumption_to_gdp_ratio",
      +  "get_household_savings_rate",
      +  "get_household_debt_to_income_ratio",
      +  "get_retail_sales",
      +  "get_industrial_production_index",
      +  "get_housing_starts",
      +  "get_real_personal_income",
      +  "get_recession_indicator",
      +  "get_commercial_real_estate_prices",
      +  "get_credit_to_gdp_gap",
      +  "get_debt_service_ratio",
      +  "get_credit_to_gdp_ratio",
      +  "get_commodity_forward_curve",
      +  "get_commodity_term_structure",
      +  "get_output_gap",
      +  "get_real_interest_rate",
      +  "get_real_effective_exchange_rate",
      +  "get_misery_index",
      +  "get_banking_crisis",
      +  "get_currency_crisis",
      +  "get_sovereign_debt_crisis",
      +  "get_real_gross_domestic_product_per_capita",
      +  "get_trade_balance",
      +  "get_implied_volatility",
      +  "get_stress_test_scenario",
      +  "get_long_run_asset_returns",
      +  "get_millennium_of_macroeconomic_data",
      +  "get_scenario_set",
      +  "get_asset_class_proxies",
      +  "get_economic_calendar"
      +]
    • addedInput schema / properties / lag / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "items": {
      +      "type": "integer"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / lag / type
      Removed value: -"integer"
  3. Changed3 schema fields changedv2.3.2
    • addedInput schema / properties / borrowers
      Added value: +{
      +  "default": "private",
      +  "description": "For get_debt_service_ratio: The borrowing sector: \"private\" (households and non-financial corporations together), \"households\" or \"corporations\" (non-financial corporations). For get_credit_to_gdp_ratio: The borrowing sector: \"private\" (households and non-financial corporations), \"households\", \"corporations\" (non-financial corporations), \"government\" (at nominal value) or \"non_financial\" (all three together).",
      +  "type": "string"
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_business_confidence_index",
      -  "get_composite_leading_indicator",
      -  "get_consumer_confidence_index",
      -  "get_consumer_price_index",
      -  "get_current_account_balance",
      -  "get_current_account_balance_to_gdp_ratio",
      -  "get_exchange_rates",
      -  "get_exports",
      -  "get_exports_to_gdp_ratio",
      -  "get_fixed_investment",
      -  "get_fixed_investment_to_gdp_ratio",
      -  "get_gross_domestic_product",
      -  "get_gross_domestic_product_deflator",
      -  "get_gross_domestic_product_growth",
      -  "get_shiller_stock_market_data",
      -  "get_house_prices",
      -  "get_imports",
      -  "get_imports_to_gdp_ratio",
      -  "get_inflation_rate",
      -  "get_investment",
      -  "get_investment_to_gdp_ratio",
      -  "get_money_supply",
      -  "get_producer_price_index",
      -  "get_rent_prices",
      -  "get_share_prices",
      -  "get_total_consumption",
      -  "get_total_consumption_to_gdp_ratio",
      -  "get_household_savings_rate",
      -  "get_household_debt_to_income_ratio",
      -  "get_retail_sales",
      -  "get_industrial_production_index",
      -  "get_housing_starts",
      -  "get_real_personal_income",
      -  "get_recession_indicator",
      -  "get_commercial_real_estate_prices",
      -  "get_commodity_forward_curve",
      -  "get_output_gap",
      -  "get_real_interest_rate",
      -  "get_real_effective_exchange_rate",
      -  "get_misery_index",
      -  "get_banking_crisis",
      -  "get_currency_crisis",
      -  "get_sovereign_debt_crisis",
      -  "get_real_gross_domestic_product_usd",
      -  "get_real_gross_domestic_product_per_capita",
      -  "get_trade_balance",
      -  "get_implied_volatility",
      -  "get_stress_test_scenario",
      -  "get_long_run_asset_returns",
      -  "get_millennium_of_macroeconomic_data",
      -  "get_scenario_set",
      -  "get_asset_class_proxies",
      -  "get_economic_calendar"
      -]New value: +[
      +  "get_business_confidence_index",
      +  "get_composite_leading_indicator",
      +  "get_consumer_confidence_index",
      +  "get_consumer_price_index",
      +  "get_current_account_balance",
      +  "get_current_account_balance_to_gdp_ratio",
      +  "get_exchange_rates",
      +  "get_exports",
      +  "get_exports_to_gdp_ratio",
      +  "get_fixed_investment",
      +  "get_fixed_investment_to_gdp_ratio",
      +  "get_gross_domestic_product",
      +  "get_gross_domestic_product_deflator",
      +  "get_gross_domestic_product_growth",
      +  "get_shiller_stock_market_data",
      +  "get_supply_chain_pressure_index",
      +  "get_house_prices",
      +  "get_imports",
      +  "get_imports_to_gdp_ratio",
      +  "get_inflation_rate",
      +  "get_investment",
      +  "get_investment_to_gdp_ratio",
      +  "get_money_supply",
      +  "get_producer_price_index",
      +  "get_rent_prices",
      +  "get_share_prices",
      +  "get_total_consumption",
      +  "get_total_consumption_to_gdp_ratio",
      +  "get_household_savings_rate",
      +  "get_household_debt_to_income_ratio",
      +  "get_retail_sales",
      +  "get_industrial_production_index",
      +  "get_housing_starts",
      +  "get_real_personal_income",
      +  "get_recession_indicator",
      +  "get_commercial_real_estate_prices",
      +  "get_credit_to_gdp_gap",
      +  "get_debt_service_ratio",
      +  "get_credit_to_gdp_ratio",
      +  "get_commodity_forward_curve",
      +  "get_output_gap",
      +  "get_real_interest_rate",
      +  "get_real_effective_exchange_rate",
      +  "get_misery_index",
      +  "get_banking_crisis",
      +  "get_currency_crisis",
      +  "get_sovereign_debt_crisis",
      +  "get_real_gross_domestic_product_usd",
      +  "get_real_gross_domestic_product_per_capita",
      +  "get_trade_balance",
      +  "get_implied_volatility",
      +  "get_stress_test_scenario",
      +  "get_long_run_asset_returns",
      +  "get_millennium_of_macroeconomic_data",
      +  "get_scenario_set",
      +  "get_asset_class_proxies",
      +  "get_economic_calendar"
      +]
    • changedInput schema / properties / limit / description
      Previous value: -"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."New value: +"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead, and rows per ticker (an earnings calendar) are selected per ticker. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."
  4. Changed5 schema fields changedv2.3.1
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-27"New value: +""
    • changedInput schema / properties / end_date / description
      Previous value: -"End of the date range in YYYY-MM-DD format."New value: +"End of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window)."
    • changedInput schema / properties / limit / description
      Previous value: -"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length."New value: +"The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length. 0 returns every row."
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-28"New value: +""
    • changedInput schema / properties / start_date / description
      Previous value: -"Start of the date range in YYYY-MM-DD format."New value: +"Start of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window)."
  5. Changed6 schema fields changedv2.3.0
    • changedInput schema / properties / contracts / description
      Previous value: -"The number of sequential monthly contracts ahead of today to attempt to fetch."New value: +"The number of contracts to return, the nearest listed ones from the current month on."
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-14"New value: +"2026-10-27"
    • changedInput schema / properties / period / description
      Previous value: -"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_inflation_rate, get_producer_price_index, get_share_prices; 'daily' for get_implied_volatility; 'monthly' for get_asset_class_proxies."New value: +"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_inflation_rate, get_producer_price_index, get_share_prices; 'daily' for get_asset_class_proxies, get_implied_volatility."
    • changedInput schema / properties / series / description
      Previous value: -"The series to include, matched on (part of) their name without regard to case, e.g. \"Bank Rate\" or [\"consols\", \"share prices\"]."New value: +"Analyze the indicators of other tools instead of the tickers' prices: references separated by ';', each tool:indicator:tickers-or-countries with an optional :column, e.g. 'valuation:get_price_to_earnings_ratio:AAPL,MSFT; macroeconomics:get_inflation_rate:United States' or 'rates:get_government_bond_yield_curve:United States,Germany:10Y'. Every ticker or country becomes a series named after it, which dependent_ticker and independent_tickers then name. Use start_date for a long enough history."
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-15"New value: +"2021-10-28"
    • changedInput schema / properties / year / description
      Previous value: -"The year of the Federal Reserve's stress test."New value: +"The year of the Federal Reserve's stress test, from 2025."
  6. Changed55 schema fields changedv2.2.3
    • addedInput schema / properties / accept_licence
      Added value: +{
      +  "default": false,
      +  "description": "Confirms that the data is used for non-commercial purposes, as its licence (CC BY-NC-SA 4.0) requires.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / asset_class
      Added value: +{
      +  "default": "equity",
      +  "description": "\"equity\", \"housing\", \"bonds\", \"bills\", \"risky\", \"safe\" or \"wealth\".",
      +  "type": "string"
      +}
    • addedInput schema / properties / asset_classes
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The asset classes to include, from \"Private Equity\", \"Infrastructure\", \"Hedge Funds\", \"Merger Arbitrage\", \"Private Credit\", \"Real Estate\", \"Investment Grade Credit\" and \"High Yield Credit\"."
      +}
    • addedInput schema / properties / authority
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "For get_stress_test_scenario: \"federal_reserve\" or \"esrb\". For get_scenario_set: The regulator: \"dnb\". Leave unset to use the default of the indicator you selected. Defaults are 'dnb' for get_scenario_set; 'federal_reserve' for get_stress_test_scenario."
      +}
    • changedInput schema / properties / commodity / description
      Previous value: -"Value for commodity. Leave unset to use the default of the indicator you selected. Required by: get_commodity_forward_curve."New value: +"The commodity to retrieve the curve for. One of \"Crude Oil\", \"Natural Gas\", \"Gold\", \"Silver\", \"Copper\", \"Corn\", \"Wheat\" or \"Soybeans\". Leave unset to use the default of the indicator you selected. Required by: get_commodity_forward_curve."
    • removedInput schema / properties / commodity / title
      Removed value: -"Commodity"
    • addedInput schema / properties / component
      Added value: +{
      +  "default": "total",
      +  "description": "Part of final consumption: 'total', 'household' or 'government'.",
      +  "type": "string"
      +}
    • changedInput schema / properties / contracts / description
      Previous value: -"Value for contracts."New value: +"The number of sequential monthly contracts ahead of today to attempt to fetch."
    • removedInput schema / properties / contracts / title
      Removed value: -"Contracts"
    • addedInput schema / properties / countries / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • changedInput schema / properties / countries / description
      Previous value: -"Comma-separated country names, e.g. 'United States,Germany,Japan'."New value: +"Country names, comma-separated or as a list, e.g. 'United States,Germany,Japan'."
    • removedInput schema / properties / countries / title
      Removed value: -"Countries"
    • removedInput schema / properties / countries / type
      Removed value: -"string"
    • addedInput schema / properties / currencies
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The currencies to keep, e.g. \"USD\" or [\"USD\", \"EUR\"]."
      +}
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-02"New value: +"2026-10-14"
    • removedInput schema / properties / end_date / title
      Removed value: -"End Date"
    • addedInput schema / properties / end_of_period
      Added value: +{
      +  "default": false,
      +  "description": "Whether to return the rate at the end of each month, quarter or year instead of its average.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / events
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Parts of event names to keep, matched without regard to case, e.g. \"PMI\" for every purchasing managers' index or [\"CPI\", \"Unemployment\"]."
      +}
    • addedInput schema / properties / gmdb_forecasts
      Added value: +{
      +  "default": false,
      +  "description": "Set to true to include the years the Global Macro Database projects (IMF World Economic Outlook, up to five years ahead); by default a yearly series ends with its last observation.",
      +  "type": "boolean"
      +}
    • removedInput schema / properties / gmdb_source / title
      Removed value: -"Gmdb Source"
    • removedInput schema / properties / growth / title
      Removed value: -"Growth"
    • addedInput schema / properties / impact
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The market impact to keep: \"Low\", \"Medium\" and/or \"High\", or \"All\" for every release. Leave unset to use the default of the indicator you selected. Defaults are 'High' for get_economic_calendar."
      +}
    • changedInput schema / properties / indicator / description
      Previous value: -"Name of the specific metric to calculate, e.g. 'get_asset_turnover_ratio'. Required — omitting it returns the list of available indicators."New value: +"Name of the specific metric to calculate, one of the listed values. Required — search_metrics finds the indicator (and its tool) for a metric by name."
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_business_confidence_index",
      -  "get_composite_leading_indicator",
      -  "get_consumer_confidence_index",
      -  "get_consumer_price_index",
      -  "get_current_account_balance",
      -  "get_current_account_balance_to_gdp_ratio",
      -  "get_exchange_rates",
      -  "get_exports",
      -  "get_exports_to_gdp_ratio",
      -  "get_fixed_investment",
      -  "get_fixed_investment_to_gdp_ratio",
      -  "get_gross_domestic_product",
      -  "get_gross_domestic_product_deflator",
      -  "get_house_prices",
      -  "get_imports",
      -  "get_imports_to_gdp_ratio",
      -  "get_inflation_rate",
      -  "get_investment",
      -  "get_investment_to_gdp_ratio",
      -  "get_money_supply",
      -  "get_producer_price_index",
      -  "get_rent_prices",
      -  "get_share_prices",
      -  "get_total_consumption",
      -  "get_total_consumption_to_gdp_ratio",
      -  "get_household_savings_rate",
      -  "get_household_debt_to_income_ratio",
      -  "get_retail_sales",
      -  "get_industrial_production_index",
      -  "get_housing_starts",
      -  "get_real_personal_income",
      -  "get_recession_indicator",
      -  "get_commercial_real_estate_prices",
      -  "get_commodity_forward_curve",
      -  "get_output_gap",
      -  "get_real_interest_rate",
      -  "get_real_effective_exchange_rate",
      -  "get_misery_index",
      -  "get_banking_crisis",
      -  "get_currency_crisis",
      -  "get_sovereign_debt_crisis",
      -  "get_real_gross_domestic_product_usd",
      -  "get_real_gross_domestic_product_per_capita",
      -  "get_trade_balance"
      -]New value: +[
      +  "get_business_confidence_index",
      +  "get_composite_leading_indicator",
      +  "get_consumer_confidence_index",
      +  "get_consumer_price_index",
      +  "get_current_account_balance",
      +  "get_current_account_balance_to_gdp_ratio",
      +  "get_exchange_rates",
      +  "get_exports",
      +  "get_exports_to_gdp_ratio",
      +  "get_fixed_investment",
      +  "get_fixed_investment_to_gdp_ratio",
      +  "get_gross_domestic_product",
      +  "get_gross_domestic_product_deflator",
      +  "get_gross_domestic_product_growth",
      +  "get_shiller_stock_market_data",
      +  "get_house_prices",
      +  "get_imports",
      +  "get_imports_to_gdp_ratio",
      +  "get_inflation_rate",
      +  "get_investment",
      +  "get_investment_to_gdp_ratio",
      +  "get_money_supply",
      +  "get_producer_price_index",
      +  "get_rent_prices",
      +  "get_share_prices",
      +  "get_total_consumption",
      +  "get_total_consumption_to_gdp_ratio",
      +  "get_household_savings_rate",
      +  "get_household_debt_to_income_ratio",
      +  "get_retail_sales",
      +  "get_industrial_production_index",
      +  "get_housing_starts",
      +  "get_real_personal_income",
      +  "get_recession_indicator",
      +  "get_commercial_real_estate_prices",
      +  "get_commodity_forward_curve",
      +  "get_output_gap",
      +  "get_real_interest_rate",
      +  "get_real_effective_exchange_rate",
      +  "get_misery_index",
      +  "get_banking_crisis",
      +  "get_currency_crisis",
      +  "get_sovereign_debt_crisis",
      +  "get_real_gross_domestic_product_usd",
      +  "get_real_gross_domestic_product_per_capita",
      +  "get_trade_balance",
      +  "get_implied_volatility",
      +  "get_stress_test_scenario",
      +  "get_long_run_asset_returns",
      +  "get_millennium_of_macroeconomic_data",
      +  "get_scenario_set",
      +  "get_asset_class_proxies",
      +  "get_economic_calendar"
      +]
    • removedInput schema / properties / indicator / title
      Removed value: -"Indicator"
    • removedInput schema / properties / inflation_adjusted / title
      Removed value: -"Inflation Adjusted"
    • removedInput schema / properties / lag / title
      Removed value: -"Lag"
    • addedInput schema / properties / limit
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The rows to return, like head and tail: 5 for the first five, -5 for the last five (the most recent of a time series). A table with its periods as columns (financial statements, ratios) keeps its first or last periods instead. For ETF holdings the largest (or, negative, the smallest) by weight, and for a list (e.g. news or a screener) its length."
      +}
    • addedInput schema / properties / markets
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The markets to retrieve, from \"US Equity\", \"Euro Area Equity\", \"Emerging Markets Equity\", \"US Equity Volatility\", \"US Treasury Bonds\", \"Crude Oil\", \"Gold\", \"US Treasury Rates\" and \"Japan Government Bonds\"."
      +}
    • changedInput schema / properties / measure / description
      Previous value: -"Sub-measure selector, e.g. 'M1', 'M2', or 'M3' for money supply."New value: +"Sub-measure selector, e.g. 'M1', 'M2', or 'M3' for money supply. Leave unset to use the default of the indicator you selected. Defaults are None for get_money_supply; 'real_world' for get_scenario_set."
    • removedInput schema / properties / measure / title
      Removed value: -"Measure"
    • changedInput schema / properties / oecd_source / description
      Previous value: -"Value for oecd_source."New value: +"Whether to get the data from the OECD instead of the Global Macro Database (GMDB)."
    • removedInput schema / properties / oecd_source / title
      Removed value: -"Oecd Source"
    • changedInput schema / properties / period / description
      Previous value: -"Observation frequency, e.g. 'monthly', 'quarterly', or 'annual'."New value: +"Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method). Leave unset to use the default of the indicator you selected. Defaults are None for get_consumer_price_index, get_exchange_rates, get_inflation_rate, get_producer_price_index, get_share_prices; 'daily' for get_implied_volatility; 'monthly' for get_asset_class_proxies."
    • removedInput schema / properties / period / title
      Removed value: -"Period"
    • addedInput schema / properties / quantiles
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The quantiles of the distribution per year."
      +}
    • removedInput schema / properties / quarterly / title
      Removed value: -"Quarterly"
    • changedInput schema / properties / rate_type / description
      Previous value: -"Value for rate_type."New value: +"Which nominal interest rate to use. Can be 'long_term' (10-year government bond yield) or 'short_term' (3-month money market rate)."
    • removedInput schema / properties / rate_type / title
      Removed value: -"Rate Type"
    • addedInput schema / properties / real
      Added value: +{
      +  "default": false,
      +  "description": "Whether to deflate the returns by consumer price inflation.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / returns
      Added value: +{
      +  "default": true,
      +  "description": "Whether to return the total return per period instead of the dividend-adjusted price.",
      +  "type": "boolean"
      +}
    • removedInput schema / properties / rolling / title
      Removed value: -"Rolling"
    • addedInput schema / properties / scenario
      Added value: +{
      +  "default": "adverse",
      +  "description": "\"baseline\", \"adverse\" (the Federal Reserve's severely adverse scenario) or \"historic\".",
      +  "type": "string"
      +}
    • addedInput schema / properties / scenarios
      Added value: +{
      +  "default": false,
      +  "description": "Whether to return every scenario instead of the distribution.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / series
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The series to include, matched on (part of) their name without regard to case, e.g. \"Bank Rate\" or [\"consols\", \"share prices\"]."
      +}
    • removedInput schema / properties / show_columns / title
      Removed value: -"Show Columns"
    • removedInput schema / properties / standardize / title
      Removed value: -"Standardize"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-03"New value: +"2021-10-15"
    • removedInput schema / properties / start_date / title
      Removed value: -"Start Date"
    • removedInput schema / properties / trailing / title
      Removed value: -"Trailing"
    • addedInput schema / properties / usd
      Added value: +{
      +  "default": false,
      +  "description": "Return levels in millions of US dollars instead of national currency when True, which makes them comparable across countries (Global Macro Database).",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / variables
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The variables to include, from \"Nominal rate 1Y\", \"Nominal rate 5Y\", \"Nominal rate 10Y\", \"Nominal rate 20Y\", \"Nominal rate 30Y\", \"Real rate EU 10Y\", \"Equity return\", \"Inflation EU\" and \"Inflation NL\"."
      +}
    • addedInput schema / properties / year
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The year of the Federal Reserve's stress test."
      +}
    • addedInput schema / properties / year_over_year
      Added value: +{
      +  "default": false,
      +  "description": "Whether to return the change on the same quarter a year earlier instead of on the previous quarter.",
      +  "type": "boolean"
      +}
    • removedInput schema / title
      Removed value: -"macroeconomicsArguments"
  7. Changed2 schema fields changedv2.2.1
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-08-19"New value: +"2026-10-02"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-08-20"New value: +"2021-10-03"
  8. Changed8 schema fields changedv2.2.0
    • addedInput schema / properties / commodity
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Value for commodity. Leave unset to use the default of the indicator you selected. Required by: get_commodity_forward_curve.",
      +  "title": "Commodity"
      +}
    • addedInput schema / properties / contracts
      Added value: +{
      +  "default": 12,
      +  "description": "Value for contracts.",
      +  "title": "Contracts",
      +  "type": "integer"
      +}
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-14"New value: +"2026-08-19"
    • changedInput schema / properties / gmdb_source / description
      Previous value: -"Use the OECD Global Macro Data Bank as the data source when True."New value: +"Use the Global Macro Database as the data source when True, rather than the OECD. The two are independent providers with different country and period coverage; both return rates and ratios as decimal fractions."
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_business_confidence_index",
      -  "get_composite_leading_indicator",
      -  "get_consumer_confidence_index",
      -  "get_consumer_price_index",
      -  "get_current_account_balance",
      -  "get_current_account_balance_to_gdp_ratio",
      -  "get_exchange_rates",
      -  "get_exports",
      -  "get_exports_to_gdp_ratio",
      -  "get_fixed_investment",
      -  "get_fixed_investment_to_gdp_ratio",
      -  "get_gross_domestic_product",
      -  "get_gross_domestic_product_deflator",
      -  "get_house_prices",
      -  "get_imports",
      -  "get_imports_to_gdp_ratio",
      -  "get_inflation_rate",
      -  "get_investment",
      -  "get_investment_to_gdp_ratio",
      -  "get_money_supply",
      -  "get_rent_prices",
      -  "get_share_prices",
      -  "get_total_consumption",
      -  "get_total_consumption_to_gdp_ratio"
      -]New value: +[
      +  "get_business_confidence_index",
      +  "get_composite_leading_indicator",
      +  "get_consumer_confidence_index",
      +  "get_consumer_price_index",
      +  "get_current_account_balance",
      +  "get_current_account_balance_to_gdp_ratio",
      +  "get_exchange_rates",
      +  "get_exports",
      +  "get_exports_to_gdp_ratio",
      +  "get_fixed_investment",
      +  "get_fixed_investment_to_gdp_ratio",
      +  "get_gross_domestic_product",
      +  "get_gross_domestic_product_deflator",
      +  "get_house_prices",
      +  "get_imports",
      +  "get_imports_to_gdp_ratio",
      +  "get_inflation_rate",
      +  "get_investment",
      +  "get_investment_to_gdp_ratio",
      +  "get_money_supply",
      +  "get_producer_price_index",
      +  "get_rent_prices",
      +  "get_share_prices",
      +  "get_total_consumption",
      +  "get_total_consumption_to_gdp_ratio",
      +  "get_household_savings_rate",
      +  "get_household_debt_to_income_ratio",
      +  "get_retail_sales",
      +  "get_industrial_production_index",
      +  "get_housing_starts",
      +  "get_real_personal_income",
      +  "get_recession_indicator",
      +  "get_commercial_real_estate_prices",
      +  "get_commodity_forward_curve",
      +  "get_output_gap",
      +  "get_real_interest_rate",
      +  "get_real_effective_exchange_rate",
      +  "get_misery_index",
      +  "get_banking_crisis",
      +  "get_currency_crisis",
      +  "get_sovereign_debt_crisis",
      +  "get_real_gross_domestic_product_usd",
      +  "get_real_gross_domestic_product_per_capita",
      +  "get_trade_balance"
      +]
    • addedInput schema / properties / oecd_source
      Added value: +{
      +  "default": false,
      +  "description": "Value for oecd_source.",
      +  "title": "Oecd Source",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / rate_type
      Added value: +{
      +  "default": "long_term",
      +  "description": "Value for rate_type.",
      +  "title": "Rate Type",
      +  "type": "string"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-07-15"New value: +"2021-08-20"
  9. Changed5 schema fields changed
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-09"New value: +"2026-07-14"
    • addedInput schema / properties / rolling
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Rolling window size in number of periods. When set, the metric is computed over a smoothly overlapping trailing window across the full history (e.g. period='monthly' and rolling=6 gives a rolling 6-month value) instead of one value per period, or (for economics indicators) a simple moving average used to smooth the raw series.",
      +  "title": "Rolling"
      +}
    • addedInput schema / properties / standardize
      Added value: +{
      +  "default": false,
      +  "description": "Return the Z-Score (standard score) instead of the raw values, i.e. how many standard deviations each value is from the mean of its own series. When combined with growth=True, the growth values are standardized instead of the raw values.",
      +  "title": "Standardize",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-07-10"New value: +"2021-07-15"
    • addedInput schema / properties / trailing
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Trailing window size in number of periods. Sums the raw values over the trailing N periods (e.g. trailing=4 on quarterly data gives a trailing-4-quarter / TTM-style sum) instead of returning one value per period.",
      +  "title": "Trailing"
      +}
  10. Changed2 schema fields changedv2.1.4
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-27"New value: +"2026-07-09"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-28"New value: +"2021-07-10"
  11. Changed2 schema fields changedv2.1.3
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-23"New value: +"2026-06-27"
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-24"New value: +"2021-06-28"
  12. Changed4 schema fields changedv0.1.2
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-06-22"New value: +"2026-06-23"
    • removedInput schema / properties / rounding
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "integer"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Number of decimal places to round results to.",
      -  "title": "Rounding"
      -}
    • addedInput schema / properties / show_columns
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Comma-separated names to filter the output. For historical data use the key names visible in any response record (e.g. 'Close,Volume,Return'). For financial statements use the 'metric' field values from the response (e.g. 'Revenue,Net Income,EBITDA'). Call the tool once without this parameter to see all available names, then repeat with show_columns to reduce response size and token usage.",
      +  "title": "Show Columns"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-06-23"New value: +"2021-06-24"
  13. Addedv0.1.1

TDQS

A4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only say readOnly/openWorld/idempotent; the description adds a great deal beyond them — every rate and ratio is a decimal fraction, not a percentage (0.0412 for 4.1%); get_long_run_asset_returns requires accept_licence=true for CC BY-NC-SA; get_scenario_set takes one to two minutes on first call; Yahoo Finance drops expired contracts so past-dated positions come back empty; BIS exchange rates lag about a week; BLS/FRED key coverage limits about three years. These are exactly the operational traits an agent cannot get from the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single undifferentiated wall of text with deeply nested parentheticals, no headings, no per-indicator structure, and critical caveats buried mid-paragraph. Most content is substantive, so this is a structuring failure rather than padding, but an agent cannot skim it and the front-loading is weak.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 49-parameter dispatcher over dozens of indicators, coverage is unusually thorough: data sources, frequencies, unit conventions, licensing, latency, and per-indicator special cases are all addressed, and an output schema exists so return shapes need not be described. A handful of indicators in the enum (e.g. get_composite_leading_indicator, get_share_prices, get_gross_domestic_product_deflator) get little or no prose, which is the only real gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description genuinely adds semantics beyond the schema for many parameters: quarterly=true vs period='yearly', rolling=N as moving-average smoothing vs trailing=N as a TTM sum, measure='core'/'energy'/'food'/'goods'/'services'/'shelter' with US-only caveats, borrowers sector options differing between get_debt_service_ratio and get_credit_to_gdp_ratio, generic=true meaning per-day positions rather than today's contracts. Some parameters (rank, quantiles, variables, contracts) are barely touched here, keeping it off a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence names the resource (macroeconomic indicators by country) and enumerates the indicator families it serves, and it explicitly routes currency-pair work elsewhere ('for a pair such as EURUSD use the market_data tool with tickers=...'). That is enough to separate it from market_data and econometrics. It falls short of 5 only because the scope is so broad that the 'purpose' is effectively a dispatcher over ~60 indicators, which makes at-a-glance identification harder than for a single-purpose tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states hard prerequisites ('Requires countries="United States"', 'Do NOT use tickers= for this tool') and names alternatives with the condition that selects them: market_data for FX pairs and for currency moves vs the dollar, get_economic_calendar for China's PPI, search_metrics for finding an indicator. What it lacks is an explicit negative boundary (when NOT to use the tool overall), and the guidance is scattered across a very long body rather than front-loaded.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.