{"openapi":"3.1.0","info":{"title":"Fundalyze public API","version":"1","description":"SEC fundamentals, filings, insider and congressional trades, headlines and U.S. economic indicators for US-listed companies. Authenticate with an API key (Account -> API & MCP) as `Authorization: Bearer fdz_live_...`. Reference: https://fundalyze.ai/developers/reference. Terms: https://fundalyze.ai/terms#api."},"servers":[{"url":"https://api.fundalyze.ai"}],"paths":{"/api/public/v1/tools":{"get":{"tags":["public-api"],"summary":"List the tools","description":"The catalogue (no key needed): every tool whose data source is on, with\nits description and JSON Schema input.","operationId":"list_tools","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response List Tools"}}}}}}},"/api/public/v1/search_companies":{"get":{"tags":["public-api"],"summary":"search_companies","description":"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.","operationId":"search_companies","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Company name or ticker, e.g. 'apple' or 'AAPL'.","title":"Query"},"description":"Company name or ticker, e.g. 'apple' or 'AAPL'."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":25,"minimum":1,"description":"Rows to return, 1-25.","default":10,"title":"Limit"},"description":"Rows to return, 1-25."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_company":{"get":{"tags":["public-api"],"summary":"get_company","description":"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.","operationId":"get_company","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_financials":{"get":{"tags":["public-api"],"summary":"get_financials","description":"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.","operationId":"get_financials","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."},{"name":"statement","in":"query","required":false,"schema":{"enum":["income","balance","cash_flow"],"type":"string","description":"Which statement: income, balance or cash_flow.","default":"income","title":"Statement"},"description":"Which statement: income, balance or cash_flow."},{"name":"metrics","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"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.","title":"Metrics"},"description":"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."},{"name":"period_type","in":"query","required":false,"schema":{"enum":["annual","quarterly"],"type":"string","description":"annual = fiscal years (FY2024); quarterly = discrete quarters (2024Q3).","default":"annual","title":"Period Type"},"description":"annual = fiscal years (FY2024); quarterly = discrete quarters (2024Q3)."},{"name":"years","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"How many fiscal years back, 1-20: one column per year (annual) or four per year (quarterly).","default":5,"title":"Years"},"description":"How many fiscal years back, 1-20: one column per year (annual) or four per year (quarterly)."},{"name":"include_provenance","in":"query","required":false,"schema":{"type":"boolean","description":"Also return each value's source: the XBRL concept (or formula) and the SEC accession it came from.","default":false,"title":"Include Provenance"},"description":"Also return each value's source: the XBRL concept (or formula) and the SEC accession it came from."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/list_filings":{"get":{"tags":["public-api"],"summary":"list_filings","description":"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...).","operationId":"list_filings","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."},{"name":"form_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"description":"Keep one SEC form type, exact match, e.g. 10-K, 10-Q, 8-K, 4, DEF 14A, 20-F. Omit for every form.","title":"Form Type"},"description":"Keep one SEC form type, exact match, e.g. 10-K, 10-Q, 8-K, 4, DEF 14A, 20-F. Omit for every form."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Rows to return, newest first, 1-50.","default":20,"title":"Limit"},"description":"Rows to return, newest first, 1-50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_insider_trades":{"get":{"tags":["public-api"],"summary":"get_insider_trades","description":"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.","operationId":"get_insider_trades","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Rows to return, newest filed first, 1-100.","default":20,"title":"Limit"},"description":"Rows to return, newest filed first, 1-100."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_congress_trades":{"get":{"tags":["public-api"],"summary":"get_congress_trades","description":"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.","operationId":"get_congress_trades","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Rows to return, newest filed first, 1-100.","default":20,"title":"Limit"},"description":"Rows to return, newest filed first, 1-100."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_headlines":{"get":{"tags":["public-api"],"summary":"get_headlines","description":"Recent press headlines about one company (headline, outlet, date, link; never article text), from The GDELT Project's news index, newest first.","operationId":"get_headlines","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":12,"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure.","title":"Ticker"},"description":"US ticker symbol, e.g. AAPL or BRK-B. Use search_companies when unsure."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"Headlines to return, newest first, 1-20.","default":10,"title":"Limit"},"description":"Headlines to return, newest first, 1-20."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/public/v1/get_economy":{"get":{"tags":["public-api"],"summary":"get_economy","description":"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.","operationId":"get_economy","security":[{"FundalyzeApiKey":[]}],"parameters":[{"name":"series_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}],"description":"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.","title":"Series Id"},"description":"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."},{"name":"range","in":"query","required":false,"schema":{"enum":["1Y","5Y","10Y","MAX"],"type":"string","description":"History window when series_id is given: 1Y, 5Y, 10Y or MAX.","default":"5Y","title":"Range"},"description":"History window when series_id is given: 1Y, 5Y, 10Y or MAX."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ToolResponse":{"properties":{"text":{"type":"string","title":"Text"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"}],"title":"Data"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","required":["text","data","link"],"title":"ToolResponse"}},"securitySchemes":{"FundalyzeApiKey":{"type":"http","description":"A Fundalyze API key (fdz_live_...), from Account -> API & MCP.","scheme":"bearer"}}},"security":[{"FundalyzeApiKey":[]}]}