Functions, Credits, and Examples
What each function family returns, example formulas to copy, how credits are spent, and how to fix common errors.
Both add-ins expose the same 16 functions: Google Sheets writes them as =DIVIDENDDATA_NAME(...), Excel as =DIVIDENDDATA.NAME(...). The live, searchable reference (with a point-and-click Formula Builder) lives on the Spreadsheets hub Functions tab.
The Free Functions
- DIVIDENDS: yields, payout history, growth CAGRs, ex-dividend and payment dates, payout ratios
- STATEMENT: full income statements, balance sheets, and cash flow statements; annual, quarterly, or TTM
- METRICS: 100+ line items like revenue, EPS, and free cash flow
- RATIOS: 50+ ratios like P/E, ROE, and debt-to-equity
- QUOTE: prices, moving averages, and price history
- PROFILE: sector, industry, market cap, CEO, and company info
- GROWTH: revenue, EPS, and dividend growth rates
- FUND: ETF and fund holdings, expense ratios, sector weights, and AUM
The Pro Functions
- DIVIDENDS_BATCH and QUOTE_BATCH: one formula across a whole list of tickers
- ESTIMATES and PRICE_TARGET: analyst EPS and revenue forecasts, consensus price targets
- SEGMENTS and KPIS: revenue by product and geography, business-specific KPIs
- COMMODITIES and CRYPTO: gold, oil, Bitcoin, and more
Example Formulas
A single number: =DIVIDENDDATA_DIVIDENDS("AAPL", "fwd_yield") returns Apple's forward yield in one cell.
A spilled table: =DIVIDENDDATA_RATIOS("MSFT", "PeRatio", TRUE, "annual") returns Microsoft's P/E ratio year by year, with headers.
A Pro batch: =DIVIDENDDATA_DIVIDENDS_BATCH("AAPL,MSFT,KO", "all", TRUE) returns a dividend summary row for each ticker from one formula.
How Credits Are Spent
Credits are spent per data point returned (a single value costs one credit, a spilled table one per figure) from your monthly pool (2,500 on Free, 150,000 on Pro, shared with the Terminal). The key thing to know: spreadsheets recalculate. Reopening a workbook or editing referenced cells re-runs formulas, and each re-run spends credits again. A sheet with hundreds of formulas that you open daily adds up faster than the formula count suggests. Batch functions help: one call covers a whole ticker list. Watch your live month-to-date usage on the hub's Usage tab, and see How Credits Work for the full picture.
Common Errors and Fixes
- Not signed in: open the add-in sidebar and sign in with your Terminal account email. This is the most common cause of formulas that suddenly stop returning data.
- Credits exhausted: you've used the month's pool. Wait for the monthly reset, or upgrade on the Pricing page for a larger allowance.
- Unknown ticker: check the symbol spelling, and use the search on the Terminal to confirm the exact ticker (some foreign listings carry exchange suffixes).
- A Pro function returns an upgrade message: that function is on the Pro half of the catalog; the hub's Plans tab shows the split.
Frequently Asked Questions
Do formulas keep spending credits if I just leave a sheet open?
Only when they recalculate. Reopening the workbook or editing cells a formula depends on triggers a re-run, and each re-run spends credits. A sheet sitting untouched does not drain your pool.