search_datasets
Search datasets
Answers 'which FinzData dataset holds this data?' Give a search phrase such as 'crude oil', 'insider trading' or 'housing'. Returns matching dataset ids, titles and descriptions. Use an id with describe_dataset, then call that dataset's tool (for example get_bars for prices, get_macro_vintage for macro). Free; no as_of needed.
输入参数query必填
describe_dataset
Describe dataset
Answers 'what fields and coverage does this dataset have?' Give a dataset id from search_datasets (for example prices_daily, cot, gex_daily). Returns the schema, coverage and field definitions. If the id is unknown, the error lists every valid id - call search_datasets to browse them instead of guessing.
输入参数dataset必填
Answers 'which US stocks were trading on this date - including ones that later delisted?' Give as_of (YYYY-MM-DD, defaults to today); optionally index top500/top1000/top3000 for the most-traded names priced at least $5 that day, prefix to filter, offset to page through 500 at a time. Returns the symbols trading that day across 16,000+ US stocks since 2000, delisted included. Free keys see the last 12 months; full history with a FinzData plan.
输入参数as_ofindexoffsetprefix
Answers 'what did these stocks do between these dates?' Give symbols (a list, or '/ES' for a futures root - plain 'ES' is the stock Eversource), start and end dates. Returns daily OHLCV bars clipped to as_of so no future data leaks; up to 5,000 rows per page, use next_cursor for more. Covers 16,000+ US stocks since 2000 including delisted names, plus 5,100+ ETFs. Free keys get daily bars for the last 12 months; intraday bars and full history with a FinzData plan.
输入参数barendas_ofstart必填symbols必填
backtest_export
Export bars for a backtester
Answers 'give me this stock's bars ready to load into my backtester.' Give a symbol and a framework (backtrader, backtesting_py, vectorbt, zipline, lean, nautilus, freqtrade or qlib); optionally start and end. Returns files (path, encoding, content) plus load_code - write each file at its path, then run load_code. Bars are clipped to as_of; start defaults to 365 days before end. Free keys get the last 12 months; full history with a FinzData plan.
输入参数endas_ofstartsymbol必填framework
get_fundamentals_pit
Get fundamentals (point-in-time)
Answers 'what were this company's fundamentals as known on this date - before later restatements?' Give a symbol and as_of (defaults to today). Returns SEC fundamentals as filed (earnings yield, book-to-market, ROE, leverage and more) exactly as known on that date. Covers US stocks with fundamentals from 2011. Free keys get the last 12 months; full history with a FinzData plan.
输入参数as_ofsymbol必填
get_macro_vintage
Get macro vintage
Answers 'what was inflation (or GDP, payrolls, retail sales) as first published on this date - not as later revised?' Give a series id (for example CPIAUCSL) and as_of; optionally start. Returns the series as actually published by as_of, with every vintage kept, across 22,700+ macro series (finzdata.com). Free keys get the last 12 months; full history and every vintage with a FinzData plan.
输入参数as_ofstartseries必填
get_quant_model
Get FinzData Quantitative Model readings
Answers 'what macro regime are we in, and how stressed is the S&P 500?' Give as_of (defaults to today), or nothing for the latest reading. Returns the FinzData Quantitative Model labels as known on that date - financial-conditions and risk direction, growth level and direction, inflation direction, macro quadrant (GOLDILOCKS/REFLATION/STAGFLATION/SLOWDOWN), liquidity and credit - plus the growth/inflation nowcast and the daily S&P 500 market-stress probability. Labels use each input as published on that date, never later revisions.
输入参数as_of
Answers 'how are traders positioned in this market?' Give a market (for example GOLD or CRUDE_OIL) and a start date; optionally end. Returns CFTC Commitments of Traders rows - managed money, producers, swap dealers, leveraged funds and asset managers, long/short/net - clipped to as_of, up to 5,000 rows per page. Covers CFTC COT since 1986. Free keys get the last 12 months; full history with a FinzData plan.
输入参数endas_ofstart必填market必填
get_gex
Get point-in-time GEX (dealer gamma)
Answers 'is dealer gamma long or short for this ticker - where are the gamma flip, call wall and put wall?' Give a ticker plus start/end for a time series, or a date alone for every name that session ranked by absolute net gamma. Returns one row per ticker per session: spot, net/call/put gamma in $bn per 1% move, flip, call/put walls, put-call open-interest ratio and at-the-money IV, each stamped with knowledge_time (17:00 New York). Point-in-time GEX for US stocks, ETFs and major indexes. A ticker series also returns `summary`: regime (long/short gamma), distance to the flip and walls, and a one-line read to quote. Free keys get the last 30 days; full history with a FinzData plan. meta.upgrade lists the available history options to show the user.
输入参数enddateas_ofstarttickersummary
get_political_spending
Get political spending (PoliSpend)
Answers 'who is spending election money, where, and on what?' Give a table (races, candidates, donor_geo, race_geo, flows, spending, vendors, state_local, state_local_geo); optionally cycle (2026, 2022 or 2018), state (2-letter code) and office (H or S). Returns cleaned, rolled-up FEC plus state and city filings. Free keys get every race's totals and national/regional/state donor geography; deeper tables need a PoliSpend purchase.
输入参数cyclestatetable必填office
Answers 'who owns this stock, and what does this manager hold?' Give a query such as a manager name ('BERKSHIRE') or a ticker ('AAPL'). Returns 13F holdings as known on as_of (defaults to today); filings after as_of are hidden. Free keys get the last 12 months; full history with a FinzData plan.
输入参数as_ofquery必填
Answers 'when is this earnings report, or the next CPI / payrolls / FOMC release?' Give kind earnings or macro, plus start and end dates. Returns events clipped to as_of, up to 5,000 rows per page. kind=macro returns market-moving releases by default (CPI, payrolls, GDP, PCE, retail sales, claims, ISM and more); pass all_releases=true for every data release. Earnings cover US company report dates; macro covers the full release calendar.
输入参数endkind必填as_ofstart必填all_releases
Answers 'would this strategy have worked - without look-ahead or survivorship bias?' Give a JSON spec (universe as a symbol list or top500/top1000/top3000/all, start, end, signal, rebalance D/W/M/Q, top_n, costs_bps, side long or long_short, blind=true to hide tickers). Signals: momentum, ma_cross, factor, or expr formulas over prices and point-in-time fundamentals (from 2011), e.g. 'rank(ret(252)) - rank(vol(60))'. Returns stats, benchmark stats, equity curve, warnings, snapshot id, an overfitting report (trials counted, deflated Sharpe) and a disclaimer. Prices are point-in-time with a 400-day buffer, clipped to as_of; identical specs on the same snapshot are cached and free. Free keys backtest the last 12 months; full history with a FinzData plan.
输入参数spec必填as_ofdry_run
run_strategy
Re-run a listed strategy
Answers 'how has this published strategy done since it started?' Give a slug from list_strategies; optionally end (default today). Returns stats, benchmark stats, equity curve, the published spec and the strategy page, re-running the strategy exactly as published on its full point-in-time history. Free on every tier, no API key needed. To change parameters use fork_strategy; to test your own idea use run_backtest (free tier: last 12 months; full history with any purchase).
输入参数endslug必填as_of
Answers 'which of my backtests performed best?' Give run_ids from earlier run_backtest calls in this session. Returns a table (run_id, CAGR, Sharpe, max drawdown, turnover, final equity) for each run. If a run_id is unknown, the error names it - call run_backtest again to get a fresh run_id, or list_strategies to compare published strategies instead.
输入参数run_ids必填
publish_strategy
Publish strategy
Answers 'publish this backtest as a public, reproducible strategy page.' Give a spec (same format as run_backtest), a title (1-120 characters) and your hypothesis (what would falsify it); visibility public or private. Returns the new strategy's slug and page URL. Runs the backtest on the server and publishes it at data.finzdata.com/s/<slug>, forward-tracked daily from today; only server-computed results are stored. Costs one backtest; free accounts may publish 3 a day. Free keys publish over the last 12 months; full history with a FinzData plan.
输入参数spec必填as_oftitle必填visibilitydescription
fork_strategy
Fork strategy
Answers 'copy this published strategy and change one thing.' Give a slug and changes (nested fields merged, e.g. signal lookback 252 to 126); optionally a new title. Returns the fork's slug and page URL. Re-runs the strategy on the server and publishes the fork linked to its parent. Costs one backtest. If the slug is unknown, the error says so - call list_strategies or get_strategy to find a valid slug first.
输入参数slug必填as_oftitlechanges必填
list_strategies
List hub strategies
Answers 'what are the best published strategies on the FinzData Hub?' Optionally sort by benchmark (full record re-run nightly through today; strategies beating their benchmark on return and Sharpe first), robust (deflated Sharpe), forward (forward Sharpe, 63+ days out-of-sample), new or forks; optionally filter by family (momentum, expr, ma_cross, factor) and limit. Returns the matching public strategies; each item carries vs_benchmark, the full-record verdict. Use get_strategy for one strategy's full spec and record.
输入参数sortlimitfamily
get_strategy
Get hub strategy
Answers 'show me this published strategy - its spec, backtest and forward record.' Give a slug from list_strategies. Returns the spec, server-computed backtest result, forward-tracking record and fork lineage, plus its public page URL. If the slug is unknown or the strategy is private, the error says so - call list_strategies to browse public strategies.
输入参数slug必填
star_strategy
Star a hub strategy
Answers 'star this strategy so it counts toward Trending.' Give a slug; pass unstar=true to remove your star. Returns the slug, star count and public page URL. Stars feed the Trending list; rankings stay on deflated Sharpe and forward record. If the slug is unknown or private, the error says so - call list_strategies to find a public strategy.
输入参数slug必填unstar
survivorship_audit
Survivorship-bias audit
Answers 'how much of this backtest's return is survivorship bias?' Give a spec (same format as run_backtest, universe top500/top1000/top3000 or a symbol list). Returns both stats plus the inflation in CAGR and Sharpe that survivorship bias adds. Runs it twice - once on the point-in-time universe (delisted companies included while they traded, the honest result) and once on only the names still trading today. Costs one backtest. Free keys audit the last 12 months; full history with a FinzData plan.
输入参数spec必填as_ofdry_run
get_futures
Get futures bars
Answers 'give me every ES contract since 2007' (or any futures market's history). Give a root (ES, NQ, YM, RTY, CL, GC, SI, NG, ZN, ZB, VX, 6E and more; a leading '/' is fine) for the continuous back-adjusted series, or a contract (e.g. ESZ26) for one contract; optionally interval (1min, 5min, 15min, 30min, 1hour) for intraday bars. Returns daily OHLCV and open interest, clipped to as_of. Covers 139 futures markets (CME, CBOT, NYMEX, COMEX, ICE, Eurex, Cboe) with every individual contract since 2007. Free keys get the last 30 days; full history with a FinzData plan.
输入参数endroot必填as_ofstartcontractintervalcontinuous
get_futures_rolls
Get futures roll calendar
Answers 'when does ES roll next - and what back-adjustment did the roll add?' Give a root (ES, CL, GC and more) or ALL for every market; optionally start and end. Returns the roll calendar for all 139 futures markets since 2007: for each front-month contract its first and last date as front month, expiry, the next contract, the roll date, trading days before expiry, and the back-adjustment added to its prices in the continuous series. The current front month carries an estimated next roll date.
输入参数endroot必填start
get_crypto
Get crypto bars
Answers 'what did BTC (or ETH, SOL) do?' Give a symbol (pair, e.g. BTC-USD) and optionally interval (1min, 5min, 15min, 30min, 1hour or 1day, default 1day) plus start and end. Returns OHLCV bars clipped to as_of. Covers 512 crypto pairs (BTC-USD since 2013, ETH-USD since 2016, SOL-USD and more). Free keys get daily bars for the last 12 months; intraday bars and full history with a FinzData plan.
输入参数endas_ofstartsymbol必填interval
get_fx
Get FX (currency) bars
Answers 'what did EURUSD (or USDJPY) do?' Give a symbol (currency pair, e.g. EURUSD) and optionally interval (1min, 5min, 15min, 30min, 1hour or 1day, default 1day) plus start and end. Returns OHLC bars, times in US Eastern, clipped to as_of. Covers 79 currency pairs (EURUSD, USDJPY, GBPUSD and more) since January 2010. Free keys get daily bars for the last 12 months; paid keys get every bar size.
输入参数endas_ofstartsymbol必填interval
get_index
Get index bars (SPX, NDX, VIX, ...)
Answers 'what did the S&P 500 (or VIX) do?' Give a symbol (index, e.g. SPX, NDX, VIX, RUT, DXY) and optionally interval (1min, 5min, 15min, 30min, 1hour or 1day, default 1day) plus start and end. Returns OHLC bars, times in US Eastern, clipped to as_of. Covers 123 indexes: S&P 500, Nasdaq-100, Dow, Russell 2000, VIX and its term structure, sector and style indexes, DAX, AEX, the dollar index and Treasury yield indexes. Free keys get daily bars for the last 12 months; paid keys get every bar size.
输入参数endas_ofstartsymbol必填interval
get_ticks
Get tick trades (every trade print)
Answers 'show me every NVDA trade on this day.' Give a symbol and a day (YYYY-MM-DD); optionally start/end times (HH:MM, US Eastern) to narrow the window, or omit day to list the days available. Returns every trade print (time in UTC nanoseconds and ISO, price, size, exchange, condition codes) for 1,100+ US stocks and ETFs over the last 5 years. Buyers get the trades; other keys get the day's trade count, first and last trade and the history options available. Free sample for every key: all trades on 2026-10-01 for SPY, QQQ, NVDA, AAPL, TSLA, MSFT, AMZN, META, AMD and IWM.
输入参数dayendas_ofstartsymbol必填
get_global_pulse
Get global activity data (shipping, ports, air, road)
Answers 'how busy is the Suez Canal (or Singapore port, or US airspace) right now?' Give a dataset (chokepoints, ports, port_calls, air, air_europe, air_us or road); optionally match to filter by name or id (e.g. Suez, Singapore, JFK) and dim for air data. Returns daily real-world activity that leads the official statistics: ship transits through 28 chokepoints since 2019, port calls and estimated imports/exports for 2,000+ ports, daily flights by airport, airline, country and region, US flights, cancellations and delays since 1987, and toll and congestion-zone traffic. Taiwan and Korea chip exports are macro series - use get_macro_vintage for those.
输入参数dimendas_ofmatchstartdataset必填
translate_stockcharts_scan
Translate a StockCharts scan
Answers 'turn my StockCharts scan into a FinzData backtest.' Give a StockCharts scan (e.g. '[type = stock] and [daily close > daily sma(50,daily close)] and [rsi(14) < 70]'). Returns the FinzData signal formula (expr), universe, notes and a ready-to-run backtest spec; clauses not yet supported are listed, never guessed. No data is fetched - call run_backtest with the returned spec, or backtest_stockcharts_scan to run it directly.
输入参数scan必填start
backtest_stockcharts_scan
Backtest a StockCharts scan
Answers 'backtest my StockCharts scan on real history.' Give a scan and a start date; optionally end, symbols (e.g. a ChartList) to restrict the universe, top_n (default 50) and rebalance (D/W/M/Q, default W). Each rebalance holds the stocks that pass the scan, equally weighted up to top_n, at 10 bps costs, on point-in-time US stocks since 2000 with delisted names included. Returns the translation plus the same stats, benchmark and equity curve as run_backtest. Costs one backtest; free keys cover the last 12 months.
输入参数endscan必填as_ofstart必填top_nsymbolsrebalance
register_strategy
Register Strategy
Answers 'score my signal out-of-sample from today, with a record nobody can edit.' Give agent_name, a signal formula, universe (top500/top1000/top3000/all), rebalance (daily/weekly/monthly), side (long/long_short) and top_frac (0-0.5). The strategy is scored only on data after registration, the record can never be edited or deleted, ranking starts at 63 trading sessions, and FinzData never trades on submitted signals. Returns the verified record id - use get_verified_record to read it back.
输入参数side必填signal必填top_frac必填universe必填rebalance必填agent_name必填
get_verified_record
Get Verified Record
Answers 'show me this verified strategy's forward record.' Give a record_id from register_strategy or the verified_board. Returns the record: signal, universe, registration date and every forward result since. If the id is unknown, the error says so - call verified_board to browse records and copy a valid id.
输入参数record_id必填
verified_board
Verified Board
Answers 'which verified strategies are leading?' Optionally give limit (1-200, default 50). Returns the leaderboard of verified strategies, ranked on forward results scored only after registration. Use get_verified_record for one record's full detail.
输入参数limit
Answers 'prove no verified record was edited or back-dated.' Give nothing. Returns the hash chain over every verified record so anyone can check the record is intact. If the check fails, the result names the broken link - contact [email protected] with the record id.
无需输入参数。
retire_strategy
Retire Strategy
Answers 'stop forward-tracking one of my verified strategies.' Give the record_id you registered. Returns the retired record id. It stops accruing new forward results, keeps its full history and stays public on the Verified board marked retired. If the id is unknown or is not yours, the error says so - call verified_board to find your record's id.
输入参数record_id必填
search_mcp_servers
Search MCP Servers
Answers 'which financial MCP servers can I connect to - and which are healthy?' Give a search phrase q, optionally a category, a minimum grade (A-F) and a limit (1-50, default 10). Returns servers graded nightly by FinzData for health, protocol conformance and prompt-injection risk, with install URLs. Use get_mcp_server for one server's full listing.
输入参数qlimitcategorymin_grade
get_mcp_server
Get MCP Server
Answers 'show me this MCP server's listing, tools and probe history.' Give a slug from search_mcp_servers. Returns the listing with tools, probe history, issues and verified-data status, plus its directory page URL. If the slug is unknown, the error says so - call search_mcp_servers to browse servers and copy a valid slug.
输入参数slug必填
claim_mcp_server
Claim MCP Server
Answers 'claim this directory listing so I can enable price-accuracy checks for it.' Give the slug of the listing you own; first claimant wins. Returns the claimed slug. If it is already claimed or the slug is unknown, the error says so - contact [email protected] to dispute a claim.
输入参数slug必填