Skip to main content
Glama
Finance Toolkit

Finance Toolkit

models

Read-onlyIdempotent

Calculates valuation, credit risk, quality, and manipulation scores for selected tickers, helping assess intrinsic value and compare companies using ready financial metrics.

Instructions

Pre-computed financial models (WACC, DuPont analysis, Extended DuPont analysis, Enterprise value breakdown, intrinsic value/DCF, Gordon Growth Model, Altman Z-Score, Piotroski F-Score, Beneish M-Score, Economic Value Added (EVA), Present Value of Growth Opportunities, Sustainable Growth Rate, Internal Growth Rate, Graham Number). get_altman_z_score takes model='original' (listed manufacturers, default), 'private' (Z', book equity), 'non-manufacturing' (Z'', no sales term) or 'emerging' (Z''-EM = Z'' + 3.25), each with its own zones. get_taffler_z_score is the UK Taffler z-score (below zero is at risk). get_return_decomposition splits the share price return into EPS growth and P/E change (the multiple), plus dividends for the total return, year over year by default (lag= periods; logarithmic=true for parts that add up; NaN split when earnings are not positive). Valuation: get_reverse_discounted_cash_flow (the growth rate the share price implies, next to the historical growth), get_earnings_power_value (Greenwald's no-growth value), get_h_model (Fuller-Hsia dividend discount model with growth declining from high_growth_rate to stable_growth_rate), get_two_stage_dividend_discount_model (transition_periods= makes it three-stage), get_justified_multiples (justified trailing/leading P/E and P/B, next to the actual multiples), get_intrinsic_valuation with historical=true (the DCF value for every period), get_monte_carlo_intrinsic_valuation (percentiles of the DCF value and the probability it exceeds the price) and get_peer_comparison (valuation, margins, returns, growth and leverage against the company's peers, or peers={'AAPL': ['MSFT', 'GOOGL']}). The valuation models need no inputs: the required return defaults to each company's cost of equity (CAPM with its country's equity risk premium) and the discount rate of the DCFs to its WACC; the dividend models grow at the dividend per share growth (CAGR), the DCFs at the reinvestment rate times the return on capital, and the stable (perpetual) growth is that growth kept within 0 and 2.5%. Values per period use the rates and growth known at each period end. A company (or period) whose rate does not exceed its stable growth is left out. rate_of_return=, growth_rate= and the like override them, as one number or one per ticker ({'AAPL': 0.08}). Credit: get_merton_distance_to_default (Merton/KMV asset value, distance to default and probability of default per year), get_campbell_hilscher_szilagyi_score (Campbell-Hilscher-Szilagyi failure probability from accounting and market data: the monthly probability of failing 12 months ahead, with its eight variables, measured on each fiscal period end) and get_synthetic_credit_rating (Damodaran's rating, default spread and cost of debt from interest coverage). Quality and manipulation scores: get_magic_formula (Greenblatt ranking across the tickers given), get_mohanram_g_score (relative to the tickers given, so pass peers), get_quality_score (Quality Minus Junk: z-scores of profitability, growth, safety and payout ranked across the tickers given, at least three; growth_years= sets the growth window, so use an earlier start_date), get_dechow_f_score, get_montier_c_score and get_accruals_ratio (Sloan). weighted_average_cost_of_capital= defaults to each company's latest WACC. Requires tickers='AAPL' — use comma-separated values for multiple tickers. Supports quarterly=true and start_date/end_date. basket=true also adds up the tickers into one company, 'Total', whose models are calculated on the summed statements (e.g. the Piotroski F-Score or Altman Z-Score of a group of companies together); the models that value a share stay empty for it and the scores that rank the tickers against each other (Magic Formula, Mohanram G-Score, Quality Score) leave it out. On quarterly data the distress scores (Altman, Taffler, Ohlson, Zmijewski, Springate, Grover, Fulmer, Piotroski, Beneish) use a trailing year by default and compare with the same quarter a year earlier; trailing=1 scores single quarters. get_altman_z_score (with the cut-offs of the model asked for: original 1.81/2.99, private 1.23/2.90, non-manufacturing 1.10/2.60, emerging 4.35/5.85), get_zmijewski_score (0), get_springate_score (0.862) and get_taffler_z_score (0) add a Zone row per ticker, 'Distress', 'Grey' or 'Safe'; zone=false leaves it out. get_factor_analysis: factor analysis (predictive power) of the models across tickers: do the tickers that score high on one go on to return more than those that score low? Needs tickers= with at least ten, preferably twenty or more tickers. metrics= a model name, a comma-separated list, or a collection: 'scores' (default: Piotroski, Altman Z, Beneish M, Ohlson O, Zmijewski, Springate, Grover, Fulmer H, Taffler z, Campbell-Hilscher-Szilagyi, Dechow F, Montier C and Mohanram G) or 'all' (adds accruals ratio, Tobin's Q, growth rates, magic formula, Merton distance to default); column= picks a component instead of the score. Returns a row per metric and horizon: the mean information coefficient (IC, the Spearman rank correlation between the metric and the later returns), its standard deviation, IC information ratio, t-statistic, p-value, share of positive periods, number of periods, the Top Minus Bottom quantile spread, quantile turnover and rank autocorrelation. detail='information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part per period (or per quantile) for a single metric. period= sets how often it is evaluated (monthly by default), horizons= the periods ahead (e.g. 12 or [1, 12]), quantiles= the number of quantiles (5). Other parameters (e.g. trailing=) pass to the models. The IC is reported as measured: a negative IC means low scores go on to outperform. Scores apply from the fiscal period end, so there is no look-ahead.

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": "models"
  }
}

Input Schema

NameRequiredDescriptionDefault
lagNoNumber of periods to lag when computing growth rates. Leave unset to use the default of the indicator you selected. Defaults differ between indicators.
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.
seedNoThe seed of the random numbers, so that results can be reproduced.
zoneNoWhether to add a "Zone" row per ticker: "Distress" below Springate's cut-off of 0.862, "Safe" from it. Not with growth or standardize. Leave unset to use the default of the indicator you selected. Defaults are True for get_altman_z_score, get_springate_score, get_taffler_z_score, get_zmijewski_score.
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.
modelNoThe model to use: "original" (listed manufacturers, market value of equity), "private" (Z', book value of equity), "non-manufacturing" (Z'', book value of equity, no sales term) or "emerging" (Z''-EM, Z'' plus 3.25).original
peersNoThe peers per ticker, e.g. {"AAPL": ["MSFT", "GOOGL"]}.
basketNoAlso analyse the tickers as one company, 'Total': its statements are the sums of theirs and its ratios are calculated on those sums (per-share figures stay empty).
columnNoThe price column to use, e.g. 'Close' or 'Adj Close'; for get_factor_analysis the output of a metric with several, e.g. 'Signal Line'.
detailNoget_factor_analysis only: 'information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part for a single metric instead of the summary.
growthNoReturn period-over-period growth rates instead of absolute values.
periodNoObservation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method).monthly
dilutedNoWhether to use the diluted Earnings per Share.
metricsNoget_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'.scores
periodsNoFor get_earnings_power_value: The number of periods the operating margin and tax rate are averaged over; with `trailing`, the number of trailing sums, `trailing` calendar periods apart so that they do not overlap, counted back from the latest reported one. A sum that includes a missing period is left out of the average. For get_intrinsic_valuation: The number of periods to use for the cash flow projections. For get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow: The number of projection periods.
tickersNoComma-separated ticker symbols, e.g. 'AAPL,MSFT,GOOGL'.
end_dateNoEnd of the date range in YYYY-MM-DD format; left empty, today (or the indicator's own window).
horizonsNoThe number of periods the forward returns cover.
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.
firm_typeNoThe table to use: "large" (market capitalization above five billion), "small" (smaller and riskier firms), "financial" (banks and other financial firms) or "auto", which picks large or small from the market capitalization of every period.auto
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 number of quantiles the tickers are sorted into per period.
quarterlyNoReturn quarterly data instead of annual when True.
historicalNoWhether to value every period instead of only the most recent one, which gives the intrinsic value per share over time. Each period is valued from the base cash flow ending in it and the cash, debt and shares reported at its end.
start_dateNoStart of the date range in YYYY-MM-DD format; left empty, five years before today (or the indicator's own window).
growth_rateNoAssumed constant growth rate as a decimal.
logarithmicNoWhether to return log returns, which add up, instead of simple returns, which multiply.
simulationsNoThe number of simulations.
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.
growth_yearsNoThe number of years over which the growth and the earnings volatility are measured.
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.
time_horizonNoThe horizon in years over which default is measured.
periods_apartNoThe number of periods between the dates the quantile turnover and the rank autocorrelation compare.
cash_flow_typeNoFor get_intrinsic_valuation: The type of cash flow to use for the cash flow projections. The other options are "Free Cash Flow" and "Operating Cash Flow" as reported on the cash flow statement; both are after interest, so discounting them at the WACC and subtracting the debt counts the cost of debt twice. For get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow: The cash flow to project: "Free Cash Flow to Firm" (see `get_free_cash_flow_to_firm`), the cash flow to debt and equity holders that the WACC discounts into an enterprise value; or "Free Cash Flow" or "Operating Cash Flow" as reported, which are after interest (cash flows to equity), so that...Free Cash Flow to Firm
rate_of_returnNoThe required rate of return, one number, or a list or dict with a rate per ticker.
risk_free_rateNoThe US Treasury yield used as the risk-free rate: '13w' (the 13-week bill), '5y', '10y' (default) or '30y'.10y
calculate_dailyNoWhether to calculate the PVGO using daily historical data.
project_periodsNoThe number of years to project the intrinsic value for, beyond the last complete period.
benchmark_tickerNoTicker used as the market benchmark, e.g. 'SPY' or '^GSPC'; 'None' for no benchmark.SPY
high_growth_rateNoFor get_h_model: The growth rate of the dividends at the start of the decline. For get_two_stage_dividend_discount_model: The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker.
variance_periodsNoThe number of yearly values the variances of G4 (return on assets) and G5 (revenue growth) are calculated over, of which at least three (or all, when fewer are asked for) must be available. With `trailing` the values are `trailing` periods apart (one a year with 4 quarters); without it, one per...
include_dividendsNoWhether to deduct Preferred Dividends Paid from Net Income when calculating the Earnings per Share, so that the earnings figure reflects what is attributable to common shareholders only.
show_full_resultsNoWhether to show the full results or just the WACC values.
stable_growth_rateNoFor get_h_model: The growth rate the decline ends at, which holds forever after it. For get_two_stage_dividend_discount_model: The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker.
transition_periodsNoThe number of years in which the growth rate declines linearly from the high to the stable growth rate (the Three-Stage Dividend Discount Model).
high_growth_periodsNoFor get_h_model: The number of years over which the growth rate declines from the high to the stable rate. For get_two_stage_dividend_discount_model: The number of years in the explicit high-growth phase. Leave unset to use the default of the indicator you selected. Defaults are 10 for get_h_model; 5 for get_two_stage_dividend_discount_model.
market_risk_premiumNoThe annual equity risk premium the Cost of Equity uses.
perpetual_growth_rateNoTerminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Defaults are None for get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation; 0.025 for get_reverse_discounted_cash_flow.
growth_rate_volatilityNoThe standard deviation of the growth rate.
perpetual_growth_rate_volatilityNoIts standard deviation.
weighted_average_cost_of_capitalNoWACC as a decimal, e.g. 0.09 for 9 %.
weighted_average_cost_of_capital_volatilityNoIts standard deviation.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.3.4
    • addedInput schema / properties / basket
      Added value: +{
      +  "default": false,
      +  "description": "Also analyse the tickers as one company, 'Total': its statements are the sums of theirs and its ratios are calculated on those sums (per-share figures stay empty).",
      +  "type": "boolean"
      +}
    • 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"
      +}
    • addedInput schema / properties / zone
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Whether to add a \"Zone\" row per ticker: \"Distress\" below Springate's cut-off of 0.862, \"Safe\" from it. Not with growth or standardize. Leave unset to use the default of the indicator you selected. Defaults are True for get_altman_z_score, get_springate_score, get_taffler_z_score, get_zmijewski_score."
      +}
  2. Changed9 schema fields changedv2.3.3
    • changedInput schema / properties / growth_rate / description
      Previous value: -"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation. Defaults are None for get_justified_multiples."New value: +"Assumed constant growth rate as a decimal."
    • changedInput schema / properties / high_growth_rate / description
      Previous value: -"For get_h_model: The growth rate of the dividends at the start of the decline. For get_two_stage_dividend_discount_model: The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_h_model, get_two_stage_dividend_discount_model."New value: +"For get_h_model: The growth rate of the dividends at the start of the decline. For get_two_stage_dividend_discount_model: The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker."
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_accruals_ratio",
      -  "get_altman_z_score",
      -  "get_beneish_m_score",
      -  "get_dechow_f_score",
      -  "get_dupont_analysis",
      -  "get_earnings_power_value",
      -  "get_economic_value_added",
      -  "get_enterprise_value_breakdown",
      -  "get_extended_dupont_analysis",
      -  "get_factor_analysis",
      -  "get_free_cash_flow_to_equity",
      -  "get_free_cash_flow_to_firm",
      -  "get_fulmer_h_score",
      -  "get_gorden_growth_model",
      -  "get_graham_number",
      -  "get_grover_score",
      -  "get_h_model",
      -  "get_internal_growth_rate",
      -  "get_intrinsic_valuation",
      -  "get_justified_multiples",
      -  "get_magic_formula",
      -  "get_market_value_added",
      -  "get_merton_distance_to_default",
      -  "get_mohanram_g_score",
      -  "get_monte_carlo_intrinsic_valuation",
      -  "get_montier_c_score",
      -  "get_ohlson_o_score",
      -  "get_peer_comparison",
      -  "get_piotroski_score",
      -  "get_present_value_of_growth_opportunities",
      -  "get_quality_score",
      -  "get_residual_income",
      -  "get_return_decomposition",
      -  "get_reverse_discounted_cash_flow",
      -  "get_springate_score",
      -  "get_sustainable_growth_rate",
      -  "get_synthetic_credit_rating",
      -  "get_tobins_q_ratio",
      -  "get_two_stage_dividend_discount_model",
      -  "get_weighted_average_cost_of_capital",
      -  "get_zmijewski_score"
      -]New value: +[
      +  "get_accruals_ratio",
      +  "get_altman_z_score",
      +  "get_beneish_m_score",
      +  "get_campbell_hilscher_szilagyi_score",
      +  "get_dechow_f_score",
      +  "get_dupont_analysis",
      +  "get_earnings_power_value",
      +  "get_economic_value_added",
      +  "get_enterprise_value_breakdown",
      +  "get_extended_dupont_analysis",
      +  "get_factor_analysis",
      +  "get_free_cash_flow_to_equity",
      +  "get_free_cash_flow_to_firm",
      +  "get_fulmer_h_score",
      +  "get_gordon_growth_model",
      +  "get_graham_number",
      +  "get_grover_score",
      +  "get_h_model",
      +  "get_internal_growth_rate",
      +  "get_intrinsic_valuation",
      +  "get_justified_multiples",
      +  "get_magic_formula",
      +  "get_market_value_added",
      +  "get_merton_distance_to_default",
      +  "get_mohanram_g_score",
      +  "get_monte_carlo_intrinsic_valuation",
      +  "get_montier_c_score",
      +  "get_ohlson_o_score",
      +  "get_peer_comparison",
      +  "get_piotroski_score",
      +  "get_present_value_of_growth_opportunities",
      +  "get_quality_score",
      +  "get_residual_income",
      +  "get_return_decomposition",
      +  "get_reverse_discounted_cash_flow",
      +  "get_springate_score",
      +  "get_sustainable_growth_rate",
      +  "get_synthetic_credit_rating",
      +  "get_taffler_z_score",
      +  "get_tobins_q_ratio",
      +  "get_two_stage_dividend_discount_model",
      +  "get_weighted_average_cost_of_capital",
      +  "get_zmijewski_score"
      +]
    • addedInput schema / properties / model
      Added value: +{
      +  "default": "original",
      +  "description": "The model to use: \"original\" (listed manufacturers, market value of equity), \"private\" (Z', book value of equity), \"non-manufacturing\" (Z'', book value of equity, no sales term) or \"emerging\" (Z''-EM, Z'' plus 3.25).",
      +  "type": "string"
      +}
    • changedInput schema / properties / perpetual_growth_rate / description
      Previous value: -"Terminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation. Defaults are 0.025 for get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow."New value: +"Terminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Defaults are None for get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation; 0.025 for get_reverse_discounted_cash_flow."
    • changedInput schema / properties / rate_of_return / description
      Previous value: -"The required rate of return. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_h_model, get_justified_multiples, get_two_stage_dividend_discount_model."New value: +"The required rate of return, one number, or a list or dict with a rate per ticker."
    • addedInput schema / properties / risk_free_rate
      Added value: +{
      +  "default": "10y",
      +  "description": "The US Treasury yield used as the risk-free rate: '13w' (the 13-week bill), '5y', '10y' (default) or '30y'.",
      +  "enum": [
      +    "13w",
      +    "5y",
      +    "10y",
      +    "30y"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / stable_growth_rate / description
      Previous value: -"For get_h_model: The growth rate the decline ends at, which holds forever after it. For get_two_stage_dividend_discount_model: The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_h_model, get_two_stage_dividend_discount_model."New value: +"For get_h_model: The growth rate the decline ends at, which holds forever after it. For get_two_stage_dividend_discount_model: The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker."
    • changedInput schema / properties / weighted_average_cost_of_capital / description
      Previous value: -"WACC as a decimal, e.g. 0.09 for 9 %. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation. Defaults are None for get_earnings_power_value, get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow."New value: +"WACC as a decimal, e.g. 0.09 for 9 %."
  3. Changed25 schema fields changedv2.3.2
    • addedInput schema / properties / column
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The price column to use, e.g. 'Close' or 'Adj Close'; for get_factor_analysis the output of a metric with several, e.g. 'Signal Line'."
      +}
    • addedInput schema / properties / detail
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "get_factor_analysis only: 'information_coefficient', 'quantile_returns', 'quantile_turnover' or 'rank_autocorrelation' returns that part for a single metric instead of the summary."
      +}
    • changedInput schema / properties / diluted / description
      Previous value: -"For get_altman_z_score: Whether to use diluted shares outstanding in the calculation. For get_enterprise_value_breakdown, get_graham_number, get_market_value_added, get_present_value_of_growth_opportunities, get_tobins_q_ratio, get_weighted_average_cost_of_capital: Whether to use diluted shares in the calculation. For get_magic_formula: Whether to use the diluted share count for the market capitalization."New value: +"Whether to use the diluted Earnings per Share."
    • changedInput schema / properties / growth_rate / description
      Previous value: -"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation."New value: +"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation. Defaults are None for get_justified_multiples."
    • addedInput schema / properties / growth_years
      Added value: +{
      +  "default": 5,
      +  "description": "The number of years over which the growth and the earnings volatility are measured.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / high_growth_periods / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / high_growth_periods / default
      Previous value: -5New value: +null
    • changedInput schema / properties / high_growth_periods / description
      Previous value: -"The number of years in the explicit high-growth phase."New value: +"For get_h_model: The number of years over which the growth rate declines from the high to the stable rate. For get_two_stage_dividend_discount_model: The number of years in the explicit high-growth phase. Leave unset to use the default of the indicator you selected. Defaults are 10 for get_h_model; 5 for get_two_stage_dividend_discount_model."
    • removedInput schema / properties / high_growth_periods / type
      Removed value: -"integer"
    • changedInput schema / properties / high_growth_rate / description
      Previous value: -"The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."New value: +"For get_h_model: The growth rate of the dividends at the start of the decline. For get_two_stage_dividend_discount_model: The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_h_model, get_two_stage_dividend_discount_model."
    • addedInput schema / properties / historical
      Added value: +{
      +  "default": false,
      +  "description": "Whether to value every period instead of only the most recent one, which gives the intrinsic value per share over time. Each period is valued from the base cash flow ending in it and the cash, debt and shares reported at its end.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / horizons
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "items": {
      +        "type": "integer"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The number of periods the forward returns cover."
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_accruals_ratio",
      -  "get_altman_z_score",
      -  "get_beneish_m_score",
      -  "get_dechow_f_score",
      -  "get_dupont_analysis",
      -  "get_earnings_power_value",
      -  "get_economic_value_added",
      -  "get_enterprise_value_breakdown",
      -  "get_extended_dupont_analysis",
      -  "get_free_cash_flow_to_equity",
      -  "get_free_cash_flow_to_firm",
      -  "get_fulmer_h_score",
      -  "get_gorden_growth_model",
      -  "get_graham_number",
      -  "get_grover_score",
      -  "get_internal_growth_rate",
      -  "get_intrinsic_valuation",
      -  "get_magic_formula",
      -  "get_market_value_added",
      -  "get_merton_distance_to_default",
      -  "get_mohanram_g_score",
      -  "get_monte_carlo_intrinsic_valuation",
      -  "get_montier_c_score",
      -  "get_ohlson_o_score",
      -  "get_peer_comparison",
      -  "get_piotroski_score",
      -  "get_present_value_of_growth_opportunities",
      -  "get_residual_income",
      -  "get_reverse_discounted_cash_flow",
      -  "get_springate_score",
      -  "get_sustainable_growth_rate",
      -  "get_synthetic_credit_rating",
      -  "get_tobins_q_ratio",
      -  "get_two_stage_dividend_discount_model",
      -  "get_weighted_average_cost_of_capital",
      -  "get_zmijewski_score"
      -]New value: +[
      +  "get_accruals_ratio",
      +  "get_altman_z_score",
      +  "get_beneish_m_score",
      +  "get_dechow_f_score",
      +  "get_dupont_analysis",
      +  "get_earnings_power_value",
      +  "get_economic_value_added",
      +  "get_enterprise_value_breakdown",
      +  "get_extended_dupont_analysis",
      +  "get_factor_analysis",
      +  "get_free_cash_flow_to_equity",
      +  "get_free_cash_flow_to_firm",
      +  "get_fulmer_h_score",
      +  "get_gorden_growth_model",
      +  "get_graham_number",
      +  "get_grover_score",
      +  "get_h_model",
      +  "get_internal_growth_rate",
      +  "get_intrinsic_valuation",
      +  "get_justified_multiples",
      +  "get_magic_formula",
      +  "get_market_value_added",
      +  "get_merton_distance_to_default",
      +  "get_mohanram_g_score",
      +  "get_monte_carlo_intrinsic_valuation",
      +  "get_montier_c_score",
      +  "get_ohlson_o_score",
      +  "get_peer_comparison",
      +  "get_piotroski_score",
      +  "get_present_value_of_growth_opportunities",
      +  "get_quality_score",
      +  "get_residual_income",
      +  "get_return_decomposition",
      +  "get_reverse_discounted_cash_flow",
      +  "get_springate_score",
      +  "get_sustainable_growth_rate",
      +  "get_synthetic_credit_rating",
      +  "get_tobins_q_ratio",
      +  "get_two_stage_dividend_discount_model",
      +  "get_weighted_average_cost_of_capital",
      +  "get_zmijewski_score"
      +]
    • changedInput schema / properties / lag / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "items": {
      -      "type": "integer"
      -    },
      -    "type": "array"
      -  }
      -]New value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "items": {
      +      "type": "integer"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / lag / default
      Previous value: -1New value: +null
    • changedInput schema / properties / lag / description
      Previous value: -"Number of periods to lag when computing growth rates."New value: +"Number of periods to lag when computing growth rates. Leave unset to use the default of the indicator you selected. Defaults differ between indicators."
    • 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."
    • addedInput schema / properties / logarithmic
      Added value: +{
      +  "default": false,
      +  "description": "Whether to return log returns, which add up, instead of simple returns, which multiply.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / metrics
      Added value: +{
      +  "default": "scores",
      +  "description": "get_factor_analysis only: the metric(s) to analyse, a method name such as 'get_price_to_earnings_ratio', a comma-separated list, or a collection of the tool (see the tool description), e.g. 'profitability'.",
      +  "type": "string"
      +}
    • addedInput schema / properties / period
      Added value: +{
      +  "default": "monthly",
      +  "description": "Observation frequency, e.g. 'daily', 'weekly', 'monthly', 'quarterly', or 'annual' (supported values differ per method).",
      +  "type": "string"
      +}
    • addedInput schema / properties / periods_apart
      Added value: +{
      +  "default": 1,
      +  "description": "The number of periods between the dates the quantile turnover and the rank autocorrelation compare.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / quantiles
      Added value: +{
      +  "default": 5,
      +  "description": "The number of quantiles the tickers are sorted into per period.",
      +  "type": "integer"
      +}
    • changedInput schema / properties / rate_of_return / description
      Previous value: -"For get_gorden_growth_model: The required rate of return. For get_two_stage_dividend_discount_model: The required rate of return (discount rate) used to discount both phases. Can be one number to use for all tickers, or a list or dict that contains a rate of return for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_two_stage_dividend_discount_model."New value: +"The required rate of return. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_h_model, get_justified_multiples, get_two_stage_dividend_discount_model."
    • changedInput schema / properties / stable_growth_rate / description
      Previous value: -"The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."New value: +"For get_h_model: The growth rate the decline ends at, which holds forever after it. For get_two_stage_dividend_discount_model: The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_h_model, get_two_stage_dividend_discount_model."
    • addedInput schema / properties / transition_periods
      Added value: +{
      +  "default": 0,
      +  "description": "The number of years in which the growth rate declines linearly from the high to the stable growth rate (the Three-Stage Dividend Discount Model).",
      +  "type": "integer"
      +}
  4. Changed6 schema fields changedv2.3.1
    • changedInput schema / properties / benchmark_ticker / description
      Previous value: -"Ticker used as the market benchmark, e.g. 'SPY' or '^GSPC'."New value: +"Ticker used as the market benchmark, e.g. 'SPY' or '^GSPC'; 'None' for no benchmark."
    • 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. Changed22 schema fields changedv2.3.0
    • changedInput schema / properties / cash_flow_type / default
      Previous value: -"Free Cash Flow"New value: +"Free Cash Flow to Firm"
    • changedInput schema / properties / cash_flow_type / description
      Previous value: -"The type of cash flow to use for the cash flow projections. Other options are \"Operating Cash Flow\", \"Change in Working Capital\", and \"Capital Expenditure\"."New value: +"For get_intrinsic_valuation: The type of cash flow to use for the cash flow projections. The other options are \"Free Cash Flow\" and \"Operating Cash Flow\" as reported on the cash flow statement; both are after interest, so discounting them at the WACC and subtracting the debt counts the cost of debt twice. For get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow: The cash flow to project: \"Free Cash Flow to Firm\" (see `get_free_cash_flow_to_firm`), the cash flow to debt and equity holders that the WACC discounts into an enterprise value; or \"Free Cash Flow\" or \"Operating Cash Flow\" as reported, which are after interest (cash flows to equity), so that..."
    • changedInput schema / properties / diluted / description
      Previous value: -"For get_altman_z_score: Whether to use diluted shares outstanding in the calculation. For get_enterprise_value_breakdown, get_graham_number, get_market_value_added, get_present_value_of_growth_opportunities, get_tobins_q_ratio, get_weighted_average_cost_of_capital: Whether to use diluted shares in the calculation."New value: +"For get_altman_z_score: Whether to use diluted shares outstanding in the calculation. For get_enterprise_value_breakdown, get_graham_number, get_market_value_added, get_present_value_of_growth_opportunities, get_tobins_q_ratio, get_weighted_average_cost_of_capital: Whether to use diluted shares in the calculation. For get_magic_formula: Whether to use the diluted share count for the market capitalization."
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-10-14"New value: +"2026-10-27"
    • addedInput schema / properties / firm_type
      Added value: +{
      +  "default": "auto",
      +  "description": "The table to use: \"large\" (market capitalization above five billion), \"small\" (smaller and riskier firms), \"financial\" (banks and other financial firms) or \"auto\", which picks large or small from the market capitalization of every period.",
      +  "type": "string"
      +}
    • changedInput schema / properties / growth_rate / description
      Previous value: -"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation."New value: +"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation, get_monte_carlo_intrinsic_valuation."
    • addedInput schema / properties / growth_rate_volatility
      Added value: +{
      +  "default": 0.02,
      +  "description": "The standard deviation of the growth rate.",
      +  "type": "number"
      +}
    • changedInput schema / properties / high_growth_periods / description
      Previous value: -"The number of periods in the explicit high-growth phase."New value: +"The number of years in the explicit high-growth phase."
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_altman_z_score",
      -  "get_beneish_m_score",
      -  "get_dupont_analysis",
      -  "get_economic_value_added",
      -  "get_enterprise_value_breakdown",
      -  "get_extended_dupont_analysis",
      -  "get_free_cash_flow_to_equity",
      -  "get_free_cash_flow_to_firm",
      -  "get_fulmer_h_score",
      -  "get_gorden_growth_model",
      -  "get_graham_number",
      -  "get_grover_score",
      -  "get_internal_growth_rate",
      -  "get_intrinsic_valuation",
      -  "get_market_value_added",
      -  "get_ohlson_o_score",
      -  "get_piotroski_score",
      -  "get_present_value_of_growth_opportunities",
      -  "get_residual_income",
      -  "get_springate_score",
      -  "get_sustainable_growth_rate",
      -  "get_tobins_q_ratio",
      -  "get_two_stage_dividend_discount_model",
      -  "get_weighted_average_cost_of_capital",
      -  "get_zmijewski_score"
      -]New value: +[
      +  "get_accruals_ratio",
      +  "get_altman_z_score",
      +  "get_beneish_m_score",
      +  "get_dechow_f_score",
      +  "get_dupont_analysis",
      +  "get_earnings_power_value",
      +  "get_economic_value_added",
      +  "get_enterprise_value_breakdown",
      +  "get_extended_dupont_analysis",
      +  "get_free_cash_flow_to_equity",
      +  "get_free_cash_flow_to_firm",
      +  "get_fulmer_h_score",
      +  "get_gorden_growth_model",
      +  "get_graham_number",
      +  "get_grover_score",
      +  "get_internal_growth_rate",
      +  "get_intrinsic_valuation",
      +  "get_magic_formula",
      +  "get_market_value_added",
      +  "get_merton_distance_to_default",
      +  "get_mohanram_g_score",
      +  "get_monte_carlo_intrinsic_valuation",
      +  "get_montier_c_score",
      +  "get_ohlson_o_score",
      +  "get_peer_comparison",
      +  "get_piotroski_score",
      +  "get_present_value_of_growth_opportunities",
      +  "get_residual_income",
      +  "get_reverse_discounted_cash_flow",
      +  "get_springate_score",
      +  "get_sustainable_growth_rate",
      +  "get_synthetic_credit_rating",
      +  "get_tobins_q_ratio",
      +  "get_two_stage_dividend_discount_model",
      +  "get_weighted_average_cost_of_capital",
      +  "get_zmijewski_score"
      +]
    • addedInput schema / properties / market_risk_premium
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The annual equity risk premium the Cost of Equity uses."
      +}
    • addedInput schema / properties / peers
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "The peers per ticker, e.g. {\"AAPL\": [\"MSFT\", \"GOOGL\"]}."
      +}
    • changedInput schema / properties / periods / description
      Previous value: -"The number of periods to use for the cash flow projections."New value: +"For get_earnings_power_value: The number of periods the operating margin and tax rate are averaged over; with `trailing`, the number of trailing sums, `trailing` calendar periods apart so that they do not overlap, counted back from the latest reported one. A sum that includes a missing period is left out of the average. For get_intrinsic_valuation: The number of periods to use for the cash flow projections. For get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow: The number of projection periods."
    • changedInput schema / properties / perpetual_growth_rate / description
      Previous value: -"Terminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation."New value: +"Terminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation. Defaults are 0.025 for get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow."
    • addedInput schema / properties / perpetual_growth_rate_volatility
      Added value: +{
      +  "default": 0.005,
      +  "description": "Its standard deviation.",
      +  "type": "number"
      +}
    • changedInput schema / properties / project_periods / description
      Previous value: -"The number of periods to project the the stock price."New value: +"The number of years to project the intrinsic value for, beyond the last complete period."
    • addedInput schema / properties / seed
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": 0,
      +  "description": "The seed of the random numbers, so that results can be reproduced."
      +}
    • addedInput schema / properties / simulations
      Added value: +{
      +  "default": 10000,
      +  "description": "The number of simulations.",
      +  "type": "integer"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-10-15"New value: +"2021-10-28"
    • addedInput schema / properties / time_horizon
      Added value: +{
      +  "default": 1,
      +  "description": "The horizon in years over which default is measured.",
      +  "type": "number"
      +}
    • addedInput schema / properties / variance_periods
      Added value: +{
      +  "default": 5,
      +  "description": "The number of yearly values the variances of G4 (return on assets) and G5 (revenue growth) are calculated over, of which at least three (or all, when fewer are asked for) must be available. With `trailing` the values are `trailing` periods apart (one a year with 4 quarters); without it, one per...",
      +  "type": "integer"
      +}
    • changedInput schema / properties / weighted_average_cost_of_capital / description
      Previous value: -"WACC as a decimal, e.g. 0.09 for 9 %. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation."New value: +"WACC as a decimal, e.g. 0.09 for 9 %. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation. Defaults are None for get_earnings_power_value, get_monte_carlo_intrinsic_valuation, get_reverse_discounted_cash_flow."
    • addedInput schema / properties / weighted_average_cost_of_capital_volatility
      Added value: +{
      +  "default": 0.01,
      +  "description": "Its standard deviation.",
      +  "type": "number"
      +}
  6. Changed51 schema fields changedv2.2.3
    • removedInput schema / properties / benchmark_ticker / title
      Removed value: -"Benchmark Ticker"
    • changedInput schema / properties / calculate_daily / description
      Previous value: -"Value for calculate_daily."New value: +"Whether to calculate the PVGO using daily historical data."
    • removedInput schema / properties / calculate_daily / title
      Removed value: -"Calculate Daily"
    • changedInput schema / properties / cash_flow_type / description
      Previous value: -"Value for cash_flow_type."New value: +"The type of cash flow to use for the cash flow projections. Other options are \"Operating Cash Flow\", \"Change in Working Capital\", and \"Capital Expenditure\"."
    • removedInput schema / properties / cash_flow_type / title
      Removed value: -"Cash Flow Type"
    • changedInput schema / properties / diluted / description
      Previous value: -"Value for diluted."New value: +"For get_altman_z_score: Whether to use diluted shares outstanding in the calculation. For get_enterprise_value_breakdown, get_graham_number, get_market_value_added, get_present_value_of_growth_opportunities, get_tobins_q_ratio, get_weighted_average_cost_of_capital: Whether to use diluted shares in the calculation."
    • removedInput schema / properties / diluted / title
      Removed value: -"Diluted"
    • 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"
    • removedInput schema / properties / growth / title
      Removed value: -"Growth"
    • changedInput schema / properties / growth_rate / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / growth_rate / title
      Removed value: -"Growth Rate"
    • changedInput schema / properties / high_growth_periods / description
      Previous value: -"Value for high_growth_periods."New value: +"The number of periods in the explicit high-growth phase."
    • removedInput schema / properties / high_growth_periods / title
      Removed value: -"High Growth Periods"
    • changedInput schema / properties / high_growth_rate / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / high_growth_rate / description
      Previous value: -"Value for high_growth_rate. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."New value: +"The constant growth rate applied to dividends during the explicit high-growth phase. Can be one number to use for all tickers, or a list or dict that contains a high growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."
    • removedInput schema / properties / high_growth_rate / title
      Removed value: -"High Growth Rate"
    • changedInput schema / properties / include_dividends / description
      Previous value: -"Value for include_dividends."New value: +"Whether to deduct Preferred Dividends Paid from Net Income when calculating the Earnings per Share, so that the earnings figure reflects what is attributable to common shareholders only."
    • removedInput schema / properties / include_dividends / title
      Removed value: -"Include Dividends"
    • 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."
    • removedInput schema / properties / indicator / title
      Removed value: -"Indicator"
    • addedInput schema / properties / lag / anyOf
      Added value: +[
      +  {
      +    "type": "integer"
      +  },
      +  {
      +    "items": {
      +      "type": "integer"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / lag / title
      Removed value: -"Lag"
    • removedInput schema / properties / lag / type
      Removed value: -"integer"
    • 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."
      +}
    • changedInput schema / properties / periods / description
      Previous value: -"Value for periods."New value: +"The number of periods to use for the cash flow projections."
    • removedInput schema / properties / periods / title
      Removed value: -"Periods"
    • changedInput schema / properties / perpetual_growth_rate / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / perpetual_growth_rate / title
      Removed value: -"Perpetual Growth Rate"
    • changedInput schema / properties / project_periods / description
      Previous value: -"Value for project_periods."New value: +"The number of periods to project the the stock price."
    • removedInput schema / properties / project_periods / title
      Removed value: -"Project Periods"
    • removedInput schema / properties / quarterly / title
      Removed value: -"Quarterly"
    • changedInput schema / properties / rate_of_return / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / rate_of_return / description
      Previous value: -"Value for rate_of_return. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_two_stage_dividend_discount_model."New value: +"For get_gorden_growth_model: The required rate of return. For get_two_stage_dividend_discount_model: The required rate of return (discount rate) used to discount both phases. Can be one number to use for all tickers, or a list or dict that contains a rate of return for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_two_stage_dividend_discount_model."
    • removedInput schema / properties / rate_of_return / title
      Removed value: -"Rate Of Return"
    • removedInput schema / properties / show_columns / title
      Removed value: -"Show Columns"
    • changedInput schema / properties / show_full_results / description
      Previous value: -"Value for show_full_results."New value: +"Whether to show the full results or just the WACC values."
    • removedInput schema / properties / show_full_results / title
      Removed value: -"Show Full Results"
    • changedInput schema / properties / stable_growth_rate / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / stable_growth_rate / description
      Previous value: -"Value for stable_growth_rate. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."New value: +"The perpetual (terminal) growth rate applied to dividends from the end of the high-growth phase onward. Can be one number to use for all tickers, or a list or dict that contains a stable growth rate for each ticker. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model."
    • removedInput schema / properties / stable_growth_rate / title
      Removed value: -"Stable Growth Rate"
    • 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"
    • addedInput schema / properties / tickers / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +]
    • removedInput schema / properties / tickers / title
      Removed value: -"Tickers"
    • removedInput schema / properties / tickers / type
      Removed value: -"string"
    • removedInput schema / properties / trailing / title
      Removed value: -"Trailing"
    • changedInput schema / properties / weighted_average_cost_of_capital / anyOf
      Previous value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "items": {
      +      "type": "number"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedInput schema / properties / weighted_average_cost_of_capital / title
      Removed value: -"Weighted Average Cost Of Capital"
    • removedInput schema / title
      Removed value: -"modelsArguments"
  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. Changed22 schema fields changedv2.2.0
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-14"New value: +"2026-08-19"
    • addedInput schema / properties / growth_rate / anyOf
      Added value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / growth_rate / default
      Previous value: -""New value: +null
    • changedInput schema / properties / growth_rate / description
      Previous value: -"Assumed constant growth rate as a decimal."New value: +"Assumed constant growth rate as a decimal. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_intrinsic_valuation."
    • removedInput schema / properties / growth_rate / type
      Removed value: -"number"
    • addedInput schema / properties / high_growth_periods
      Added value: +{
      +  "default": 5,
      +  "description": "Value for high_growth_periods.",
      +  "title": "High Growth Periods",
      +  "type": "integer"
      +}
    • addedInput schema / properties / high_growth_rate
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Value for high_growth_rate. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model.",
      +  "title": "High Growth Rate"
      +}
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_altman_z_score",
      -  "get_beneish_m_score",
      -  "get_dupont_analysis",
      -  "get_economic_value_added",
      -  "get_enterprise_value_breakdown",
      -  "get_extended_dupont_analysis",
      -  "get_gorden_growth_model",
      -  "get_graham_number",
      -  "get_internal_growth_rate",
      -  "get_intrinsic_valuation",
      -  "get_piotroski_score",
      -  "get_present_value_of_growth_opportunities",
      -  "get_sustainable_growth_rate",
      -  "get_weighted_average_cost_of_capital"
      -]New value: +[
      +  "get_altman_z_score",
      +  "get_beneish_m_score",
      +  "get_dupont_analysis",
      +  "get_economic_value_added",
      +  "get_enterprise_value_breakdown",
      +  "get_extended_dupont_analysis",
      +  "get_free_cash_flow_to_equity",
      +  "get_free_cash_flow_to_firm",
      +  "get_fulmer_h_score",
      +  "get_gorden_growth_model",
      +  "get_graham_number",
      +  "get_grover_score",
      +  "get_internal_growth_rate",
      +  "get_intrinsic_valuation",
      +  "get_market_value_added",
      +  "get_ohlson_o_score",
      +  "get_piotroski_score",
      +  "get_present_value_of_growth_opportunities",
      +  "get_residual_income",
      +  "get_springate_score",
      +  "get_sustainable_growth_rate",
      +  "get_tobins_q_ratio",
      +  "get_two_stage_dividend_discount_model",
      +  "get_weighted_average_cost_of_capital",
      +  "get_zmijewski_score"
      +]
    • addedInput schema / properties / perpetual_growth_rate / anyOf
      Added value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / perpetual_growth_rate / default
      Previous value: -""New value: +null
    • changedInput schema / properties / perpetual_growth_rate / description
      Previous value: -"Terminal (perpetual) growth rate used in DCF models."New value: +"Terminal (perpetual) growth rate used in DCF models. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation."
    • removedInput schema / properties / perpetual_growth_rate / type
      Removed value: -"number"
    • addedInput schema / properties / rate_of_return / anyOf
      Added value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / rate_of_return / default
      Previous value: -""New value: +null
    • changedInput schema / properties / rate_of_return / description
      Previous value: -"Value for rate_of_return."New value: +"Value for rate_of_return. Leave unset to use the default of the indicator you selected. Required by: get_gorden_growth_model, get_two_stage_dividend_discount_model."
    • removedInput schema / properties / rate_of_return / type
      Removed value: -"number"
    • addedInput schema / properties / stable_growth_rate
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Value for stable_growth_rate. Leave unset to use the default of the indicator you selected. Required by: get_two_stage_dividend_discount_model.",
      +  "title": "Stable Growth Rate"
      +}
    • changedInput schema / properties / start_date / default
      Previous value: -"2021-07-15"New value: +"2021-08-20"
    • addedInput schema / properties / weighted_average_cost_of_capital / anyOf
      Added value: +[
      +  {
      +    "type": "number"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / weighted_average_cost_of_capital / default
      Previous value: -""New value: +null
    • changedInput schema / properties / weighted_average_cost_of_capital / description
      Previous value: -"WACC as a decimal, e.g. 0.09 for 9 %."New value: +"WACC as a decimal, e.g. 0.09 for 9 %. Leave unset to use the default of the indicator you selected. Required by: get_intrinsic_valuation."
    • removedInput schema / properties / weighted_average_cost_of_capital / type
      Removed value: -"number"
  9. Changed5 schema fields changed
    • changedInput schema / properties / end_date / default
      Previous value: -"2026-07-09"New value: +"2026-07-14"
    • changedInput schema / properties / indicator / enum
      Previous value: -[
      -  "get_altman_z_score",
      -  "get_dupont_analysis",
      -  "get_enterprise_value_breakdown",
      -  "get_extended_dupont_analysis",
      -  "get_gorden_growth_model",
      -  "get_intrinsic_valuation",
      -  "get_piotroski_score",
      -  "get_present_value_of_growth_opportunities",
      -  "get_weighted_average_cost_of_capital"
      -]New value: +[
      +  "get_altman_z_score",
      +  "get_beneish_m_score",
      +  "get_dupont_analysis",
      +  "get_economic_value_added",
      +  "get_enterprise_value_breakdown",
      +  "get_extended_dupont_analysis",
      +  "get_gorden_growth_model",
      +  "get_graham_number",
      +  "get_internal_growth_rate",
      +  "get_intrinsic_valuation",
      +  "get_piotroski_score",
      +  "get_present_value_of_growth_opportunities",
      +  "get_sustainable_growth_rate",
      +  "get_weighted_average_cost_of_capital"
      +]
    • 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"
    • changedInput schema / properties / trailing / description
      Previous value: -"Number of trailing periods for rolling-window calculations."New value: +"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."
  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.1/5.0
Behavior5/5

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

Annotations only declare read-only, idempotent, open-world; the description adds far more: valuation defaults (cost of equity via CAPM with country ERP, WACC as discount rate, growth from DPS CAGR or reinvestment × ROIC), stable growth clamped to 0–2.5%, companies whose rate fails to exceed stable growth being dropped, `basket` 'Total' semantics and which models it blanks out, zone thresholds per Altman variant, and the explicit no-look-ahead guarantee for factor analysis. It even explains how to interpret a negative IC, which is exactly the kind of context annotations cannot carry.

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?

The content is dense but presented as a single unbroken ~650-word paragraph, making it hard to scan for the indicator an agent needs. There is visible duplication — Altman's four zone cut-offs appear twice, `zone` behavior is stated twice — and per-indicator notes are buried mid-sentence rather than grouped.

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

Completeness5/5

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

For a 52-parameter, 44-indicator tool this covers the operational essentials: required inputs, default resolution for interest/discount/growth rates, edge-case exclusion rules, quarterly vs annual treatment, and what each model family returns. With an output schema present, it correctly does not waste space describing response shapes except where the interpretation matters (factor-analysis summary rows).

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 adds real meaning on top: `rate_of_return`/`growth_rate` overrides accepted as a scalar or per-ticker dict, which models `weighted_average_cost_of_capital` defaults to, `model=` variant definitions for Altman, `detail=` and `metrics=` collections for factor analysis, and `lag=`/`logarithmic=` behavior in return decomposition. One inaccuracy holds it back: it says "Requires tickers='AAPL'" while the schema only marks `indicator` as required and `tickers` defaults to an empty string.

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 description opens by naming the resource precisely — pre-computed financial models — and enumerates the 40+ indicators behind the required `indicator` enum (WACC, DuPont, Altman Z, DCF, Piotroski, etc.), so an agent knows this is the multi-model analytics dispatcher. It is less clear on how it differs from category siblings like `valuation`, `risk` or `profitability`, which is the only thing keeping it from a 5.

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 gives substantial conditional guidance: factor analysis needs at least ten (preferably twenty) tickers, `peers` should be passed to Mohanram, `growth_years` requires an earlier start_date, `basket=true` excludes ranking models and per-share valuations, and quarterly data defaults to trailing-year distress scores with `trailing=1` for single quarters. It never routes the agent to or away from a sibling tool, so there is no explicit alternative-selection rule.

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