Developers
API reference
Every tool, its parameters and a worked example, over REST or MCP. Generated from the live catalogue.
Basics
https://api.fundalyze.ai/api/public/v1/<tool>https://api.fundalyze.ai/mcpAuthorization: Bearer fdz_live_… from Account → API & MCP, or an OAuth sign-in for connectors that support it.text (the compact table an assistant reads), data (the same content as JSON) and link (the fundalyze.ai page to check it on). MCP returns text.X-Quota-Remaining: calls left today for the key.Errors
Errors are JSON {"detail": "…"} with the status below. Over MCP a failed call is a tool error whose text is the same message.
| Status | Meaning |
|---|---|
400 | A parameter is invalid; the message names it and, for a metric key, suggests valid ones. |
401 | No key, an unknown key, or a revoked key. |
402 | The key’s account has no active subscription or trial. |
404 | Unknown ticker, series or tool, or a data source that is switched off. |
429 | Today’s quota is used, or another call with the same key is still running. |
503 | The API is temporarily switched off. |
search_companies
Find US-listed companies by name or ticker in the SEC EDGAR directory. Returns ticker, name, exchange, country and CIK, best match first. Use it first when you are not sure of a ticker.
| Parameter | Type | Default | Description |
|---|---|---|---|
query required | string (up to 100 characters) | — | Company name or ticker, e.g. 'apple' or 'AAPL'. |
limit | integer (1–25) | 10 | Rows to return, 1-25. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/search_companies?query=apple&limit=5"The same call as an MCP tools/call.
{
"name": "search_companies",
"arguments": {
"query": "apple",
"limit": 5
}
}get_company
One company's profile from its SEC filings: name, exchange, country, CIK, industry (SIC), public float (USD millions) and shares outstanding (millions) as of their 10-K cover date, and a summary of its 10-K business section. No prices or market data.
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_company?ticker=AAPL"The same call as an MCP tools/call.
{
"name": "get_company",
"arguments": {
"ticker": "AAPL"
}
}get_financials
Standardized financial statements (income, balance, cash_flow) built from SEC XBRL filings, annual or quarterly, one column per period, newest last, in USD millions (non-USD filers converted). Ask for only the metrics you need by key; margins, growth, free cash flow and per-share figures come precomputed. include_provenance shows each value's XBRL concept and SEC accession.
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
statement | string (one of income, balance, cash_flow) | income | Which statement: income, balance or cash_flow. |
metrics | list of string | — | Metric keys for the chosen statement (omit for the defaults: income: revenue, gross_profit, operating_income, net_income, eps_diluted; balance: cash, total_assets, total_liabilities, total_equity, total_debt; cash_flow: cfo, cfi, cff, capex, fcf). Repeat the parameter or comma-separate. income: revenue, cost_of_revenue, gross_profit, rd_expense, sga_expense, total_operating_expenses, operating_income, ebitda, interest_expense, pretax_income, income_tax, effective_tax_rate, net_income, eps_basic, eps_diluted, shares_diluted, dividends_per_share, gross_margin, operating_margin, net_margin, revenue_growth. balance: cash, short_term_investments, receivables, inventory, total_current_assets, ppe_net, goodwill, intangibles, total_assets, accounts_payable, deferred_revenue, current_debt, total_current_liabilities, long_term_debt, total_liabilities, retained_earnings, total_equity, shares_outstanding, total_debt, net_debt, working_capital, tangible_book_value, invested_capital, book_value_per_share. cash_flow: cf_net_income, cf_da, cf_sbc, cf_working_capital_change, cfo, capex, acquisitions, cfi, debt_issued, debt_repaid, buybacks, dividends_paid, cff, net_change_in_cash, ending_cash, fcf, fcf_margin. Industry lines (banks, insurers, REITs, utilities, oil & gas, asset managers) exist too; an unknown key's error lists every valid key. |
period_type | string (one of annual, quarterly) | annual | annual = fiscal years (FY2024); quarterly = discrete quarters (2024Q3). |
years | integer (1–20) | 5 | How many fiscal years back, 1-20: one column per year (annual) or four per year (quarterly). |
include_provenance | boolean | false | Also return each value's source: the XBRL concept (or formula) and the SEC accession it came from. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_financials?ticker=AAPL&metrics=revenue%2Cnet_income&years=3"The same call as an MCP tools/call.
{
"name": "get_financials",
"arguments": {
"ticker": "AAPL",
"metrics": [
"revenue",
"net_income"
],
"years": 3
}
}list_filings
A company's SEC filings, newest first: form, filing date, period, accession number, description and the sec.gov link. Filter by one form type (10-K, 10-Q, 8-K, 4, DEF 14A...).
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
form_type | string | — | Keep one SEC form type, exact match, e.g. 10-K, 10-Q, 8-K, 4, DEF 14A, 20-F. Omit for every form. |
limit | integer (1–50) | 20 | Rows to return, newest first, 1-50. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/list_filings?ticker=AAPL&form_type=10-K&limit=5"The same call as an MCP tools/call.
{
"name": "list_filings",
"arguments": {
"ticker": "AAPL",
"form_type": "10-K",
"limit": 5
}
}get_insider_trades
Insider transactions from SEC Forms 3/4/5 for one company, newest filed first: insider, role, transaction code, shares, price, value, shares held after, and the filing link.
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
limit | integer (1–100) | 20 | Rows to return, newest filed first, 1-100. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_insider_trades?ticker=AAPL&limit=5"The same call as an MCP tools/call.
{
"name": "get_insider_trades",
"arguments": {
"ticker": "AAPL",
"limit": 5
}
}get_congress_trades
Trades in one company's stock disclosed by members of the U.S. House and Senate (Periodic Transaction Reports), newest filed first: member, party, chamber, state, buy/sell, disclosed amount range, owner and the filing link.
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
limit | integer (1–100) | 20 | Rows to return, newest filed first, 1-100. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_congress_trades?ticker=AAPL&limit=5"The same call as an MCP tools/call.
{
"name": "get_congress_trades",
"arguments": {
"ticker": "AAPL",
"limit": 5
}
}get_headlines
Recent press headlines about one company (headline, outlet, date, link; never article text), from The GDELT Project's news index, newest first.
| Parameter | Type | Default | Description |
|---|---|---|---|
ticker required | string (up to 12 characters) | — | US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure. |
limit | integer (1–20) | 10 | Headlines to return, newest first, 1-20. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_headlines?ticker=AAPL&limit=5"The same call as an MCP tools/call.
{
"name": "get_headlines",
"arguments": {
"ticker": "AAPL",
"limit": 5
}
}get_economy
U.S. economic indicators from FRED (inflation, jobs, growth, housing, rates, credit, markets, government debt). Without series_id: every indicator's latest and prior figure and next release date. With series_id: that indicator's history as date,value rows.
| Parameter | Type | Default | Description |
|---|---|---|---|
series_id | string | — | One indicator's history, by FRED series id: CPIAUCSL, CPILFESL, PCEPI, PCEPILFE, PPIFIS, CUSR0000SAH1, GASREGW, DCOILWTICO, T5YIE, T10YIE, UNRATE, U6RATE, PAYEMS, ICSA, CCSA, JTSJOL, CIVPART, CES0500000003, A191RL1Q225SBEA, RSAFS, INDPRO, TCU, DGORDER, PCEC96, DSPIC96, PSAVERT, UMCSENT, BOPGSTB, HOUST, PERMIT, HSN1F, HPIPONM226S, MORTGAGE30US, DFF, SOFR, DPRIME, DGS3MO, DGS2, DGS5, DGS10, DGS30, T10Y2Y, T10Y3M, WALCL, M2SL, TOTALSL, DRCCLACBS, NFCI, VIXCLS, DTWEXBGS, GFDEBTN, GFDEGDQ188S, MTSDS133FMS, SAHMREALTIME. Omit for the latest value of every indicator. |
range | string (one of 1Y, 5Y, 10Y, MAX) | 5Y | History window when series_id is given: 1Y, 5Y, 10Y or MAX. |
GET with the parameters as the query string.
curl -H "Authorization: Bearer fdz_live_YOUR_KEY" "https://api.fundalyze.ai/api/public/v1/get_economy?series_id=UNRATE&range=1Y"The same call as an MCP tools/call.
{
"name": "get_economy",
"arguments": {
"series_id": "UNRATE",
"range": "1Y"
}
}