Skip to main content
Financial Datasets logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: FINANCIAL_DATASETS_AI
  • Version: 00000000_00

Tools

Slug: FINANCIAL_DATASETS_AI_GET_AS_REPORTED_FINANCIALSReturn one page of issuer-reported financial statement fields without normalization for one statement family or all statements.

Input Parameters

string
Company SEC CIK. Provide exactly one of cik or ticker on the first page.
integer
Total statement records requested across all pages. Provider pages contain at most 10 records.
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged, and omit statement_type and every query filter.
string ("annual" | "quarterly")
Reporting period type. Required on the first page; omit when continuing with cursor. As-reported routes do not support ttm.
string
Company ticker. Provide exactly one of ticker or cik on the first page.
string
Require this exact report period in YYYY-MM-DD format.
string ("income" | "balance_sheet" | "cash_flow" | "all")
As-reported statement family to return. A continuation cursor retains the original family.
string
Return report periods strictly after this YYYY-MM-DD date.
string
Return report periods strictly before this YYYY-MM-DD date.
string
Return report periods on or after this YYYY-MM-DD date.
string
Return report periods on or before this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_BENEFICIAL_OWNERSHIPReturn one page of current or historical SEC Schedule 13D and 13G stakes by subject ticker or beneficial-owner CIK.

Input Parameters

integer
Total ownership rows requested across all pages. Each provider page contains up to 10 rows.
string
Opaque next_cursor returned by a prior call. When set, omit every other field because it retains the original filters.
string
Subject company ticker. Provide exactly one of ticker or filer_cik for the first page.
boolean
Return the full amendment history of each stake instead of only its current state.
string
SEC CIK of the beneficial owner. Provide exactly one of filer_cik or ticker for the first page.
string
Require an exact SEC filing date in YYYY-MM-DD format.
string
Return filings strictly after this date in YYYY-MM-DD format.
string
Return filings strictly before this date in YYYY-MM-DD format.
string ("activist" | "passive")
Restrict results to activist Schedule 13D or passive Schedule 13G stakes.
string
Return filings on or after this date in YYYY-MM-DD format.
string
Return filings on or before this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_COMPANY_FACTSReturn a company’s identity, classification, exchange, and active-status facts by ticker or SEC CIK.

Input Parameters

string
Company SEC Central Index Key (CIK). Provide exactly one of cik or ticker.
string
Company ticker symbol. Provide exactly one of ticker or cik.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_COMPANY_KPISReturn one page of reported operating KPIs, forward guidance, or non-GAAP metrics for a company, including source provenance.

Input Parameters

integer
Total periods requested across provider pages (1-50).
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit every other field; it retains the KPI family and filters.
string ("quarterly" | "annual")
Reporting period type.
string
Company ticker symbol. Required on the first page; omit with cursor.
string ("reported" | "guidance" | "non_gaap")
KPI family to return: reported operating metrics, forward guidance, or non-GAAP metrics.
string
Restrict results to one provider-defined metric name.
string
Return records on or after this date in YYYY-MM-DD format.
string
Return records on or before this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_EARNINGSReturn one page of recent company earnings filings with quarterly and annual financial metrics, detected signals, and a continuation cursor.

Input Parameters

integer
Total report periods requested across pages (1-40; defaults to 1). A period can contain multiple filings, so the provider may return more earnings records than this value.
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit ticker and limit; it retains the original request filters.
string
Company ticker symbol. Required on the first page; omit with cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_FINANCIAL_METRICSReturn a company’s current metrics snapshot or one historical page of valuation, profitability, efficiency, liquidity, leverage, growth, and per-share metrics by ticker or SEC CIK.

Input Parameters

string
Company SEC CIK. Provide exactly one of cik or ticker unless continuing with cursor.
string ("current" | "historical")
Return the latest metrics snapshot or one page of historical metric records. Historical-only filters are rejected for current view.
integer
Total metric records requested across all pages. Provider pages contain up to 10 records.
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit view, ticker, cik, period, limit, and all date filters. A cursor-only request continues historical results.
string ("annual" | "quarterly" | "ttm")
Historical reporting period type. Required for an initial historical request.
string
Company ticker. Provide exactly one of ticker or cik unless continuing with cursor.
string
Require this exact SEC filing date. Rows without a known filing date are excluded.
string
Require this exact report period in YYYY-MM-DD format.
string
Return rows filed strictly after this date; rows without a known filing date are excluded.
string
Return rows filed strictly before this date; rows without a known filing date are excluded.
string
Return rows filed on or after this date; rows without a known filing date are excluded.
string
Return rows filed on or before this date for point-in-time research; rows without a known filing date are excluded.
string
Return report periods strictly after this date.
string
Return report periods strictly before this date.
string
Return report periods on or after this date.
string
Return report periods on or before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_FINANCIAL_STATEMENTSReturn one provider page of normalized income statements, balance sheets, cash-flow statements, or all three for a company.

Input Parameters

string
Company SEC CIK. Provide exactly one of cik or ticker for the first page.
integer
Total statement records requested across all pages. Provider pages contain up to 10 records.
string
Opaque next_cursor returned by a prior call. When set, omit every other field because the cursor retains the original route and filters.
string ("annual" | "quarterly" | "ttm")
Reporting period type. Required for the first page.
string
Company ticker. Provide exactly one of ticker or cik for the first page.
string
Require this exact SEC filing date. Rows without a known filing date are excluded.
string
Require this exact report period in YYYY-MM-DD format.
string
Return rows filed strictly after this date; rows without a known filing date are excluded.
string
Return rows filed strictly before this date; rows without a known filing date are excluded.
string ("income" | "balance_sheet" | "cash_flow" | "all")
Normalized statement family to return.
string
Return rows filed on or after this date; rows without a known filing date are excluded.
string
Return rows filed on or before this date for point-in-time research; rows without a known filing date are excluded.
string
Return report periods strictly after this date.
string
Return report periods strictly before this date.
string
Return report periods on or after this date.
string
Return report periods on or before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_GPU_PRICESReturn today’s GPU rental price index or one page of historical daily prices for a GPU model, including provider spread, changes, and source attribution.

Input Parameters

string ("current" | "historical")
Return today’s GPU prices or one page of historical daily prices.
string
Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit view, series, start_date, and end_date.
string
GPU model series ID, such as h100. Required for an initial historical request and optional for current prices. Use List Macro Options with option_type=‘gpu_price_series’ to discover IDs.
string
Last historical UTC day to include, in YYYY-MM-DD format.
string
First historical UTC day to include, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_INDEX_FUND_HOLDINGSReturn one page of a fund’s constituents by fund ticker, or one page of funds containing a security by holding ticker.

Input Parameters

string
For ticker searches only, return the fund composition in effect on or before this YYYY-MM-DD date.
integer
Total rows requested across all provider pages. Each page contains at most 10 rows; the provider documents no maximum total.
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit every other field; it retains the original direction and filters.
integer
Rows to skip on the initial request. Prefer cursor for continuation.
string
Fund ticker whose constituents to return. Provide exactly one of ticker or holding on the first page.
string
Held-security ticker used to find funds containing it. Provide exactly one of holding or ticker on the first page.
string ("equity" | "bond")
For ticker searches only, restrict constituents to equity or bond holdings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_INFLATIONReturn the latest CPI values for all or one inflation series, or monthly history for one series.

Input Parameters

string ("historical" | "current")
Return the latest CPI values or monthly history.
string
Opaque continuation returned as next_cursor; pass it alone without view, series, or date filters.
string
Inflation series ID such as cpi_all_sa; required for historical view and optional for current view.
string
Last historical month to include, expressed as YYYY-MM-DD.
string
First historical month to include, expressed as YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_INSIDER_OWNERSHIPReturn one page of company insider holdings reported on SEC Forms 3 and 5, including common and derivative positions.

Input Parameters

string
Case-insensitive substring of the insider’s name.
integer
Total holding rows requested across all pages. The provider defaults to 10 and documents no maximum.
string
Continuation URL returned as next_cursor. Pass it back unchanged and omit ticker, filters, and limit.
string
Company ticker symbol. Required for the first page; omit with cursor.
string ("3" | "3/A" | "5" | "5/A")
SEC ownership form: 3, 3/A, 5, or 5/A.
string
Exact SEC filing date in YYYY-MM-DD format.
string
Include filings accepted strictly after this YYYY-MM-DD date.
string
Include filings accepted strictly before this YYYY-MM-DD date.
string
Include filings accepted on or after this YYYY-MM-DD date.
string
Include filings accepted on or before this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_INSTITUTIONAL_HOLDINGSReturn one page of SEC 13F holdings by institution CIK or held-company ticker.

Input Parameters

integer
Total holdings requested across all provider pages.
string
Continuation cursor returned as next_cursor by a prior call. Pass it alone to continue; the cursor retains the original selector and filters.
string
Ticker of the held company. Provide exactly one of ticker or filer_cik for the first page.
string
Institutional filer’s 10-digit zero-padded SEC CIK. Provide exactly one of filer_cik or ticker for the first page.
string
Require this exact 13F report period in YYYY-MM-DD format.
string
Include report periods strictly after this YYYY-MM-DD date.
string
Include report periods strictly before this YYYY-MM-DD date.
string
Include report periods on or after this YYYY-MM-DD date.
string
Include report periods on or before this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_INTEREST_RATESReturn a central bank’s current policy rate or one newest-first page of historical daily rates for a date range. Historical pages contain up to 10 rows; use next_cursor to continue.

Input Parameters

string
Central bank code, such as FED, ECB, or BOJ. Required unless cursor is provided. Use List Macro Options to discover supported codes.
string ("historical" | "current")
Return the current policy rate or historical rate observations.
string
Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit bank, view, start_date, and end_date.
string
Last historical date to include, in YYYY-MM-DD format. Historical results default to today when omitted.
string
First historical date to include, in YYYY-MM-DD format. Historical results default to five years before end_date when both dates are omitted; omit start_date with an end_date for all available history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_LABOR_MARKETReturn the latest print for all or one US labor series, or one page of historical monthly or weekly observations for one series.

Input Parameters

string ("current" | "historical")
Return the latest labor prints or one page of historical observations.
string
Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit view, series, start_date, and end_date.
string
Labor series ID, such as payrolls_sa. Required for an initial historical request and optional for current data. Use List Macro Options with option_type=‘labor_series’ to discover IDs.
string
Last historical period to include, in YYYY-MM-DD format.
string
First historical period to include, in YYYY-MM-DD format. Any day in a month selects that month for monthly series.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_PRICE_HISTORYReturn one page of historical OHLCV stock prices for an inclusive date range at a daily, weekly, monthly, or yearly interval.

Input Parameters

string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit ticker, interval, start_date, and end_date.
string
Company ticker symbol. Required on the first page.
string
Last date to include, in YYYY-MM-DD format. Required on the first page.
string ("day" | "week" | "month" | "year")
Price aggregation interval. Required on the first page.
string
First date to include, in YYYY-MM-DD format. Required on the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_PRICE_SNAPSHOTReturn a real-time price snapshot for one ticker or snapshots for the broad market.

Input Parameters

string ("ticker" | "market")
Return one ticker snapshot or the broad market snapshot set.
string
Company ticker symbol. Required when scope is ticker; omit for market.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_SEC_FILING_ITEMSExtract selected sections from a 10-K, 10-Q, or 8-K, optionally including 8-K exhibits, and wait for asynchronous preparation when needed.

Input Parameters

string
Machine section selector. Use Item-1 style for 10-K filings and Part-1,Item-1 style for 10-Q filings. Use List Filing Options to discover other documented selectors.
integer
required
Calendar year of the filing.
string
required
Company ticker symbol.
integer
Fiscal quarter, normally needed to identify a 10-Q filing.
string ("10-K" | "10-Q" | "8-K")
required
SEC filing type to extract.
string
Exact SEC accession number when the year and filing type are ambiguous.
boolean
Include linked exhibit text for an 8-K filing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_SEGMENTED_FINANCIALSReturn one page of company-reported business or product segments for one statement family or all statements.

Input Parameters

string
Company SEC Central Index Key. Provide exactly one of cik or ticker on the first page.
integer
Total segmented-financial records requested across provider pages.
string
Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit every other field; it retains the original route and filters.
string ("annual" | "quarterly")
Reporting period type. Required on the first page; segmented financials do not support TTM.
string
Company ticker symbol. Provide exactly one of ticker or cik on the first page.
string
Require this exact report period in YYYY-MM-DD format.
string ("income" | "balance_sheet" | "cash_flow" | "all")
Statement family whose reported segments to return.
string
Include report periods strictly after this YYYY-MM-DD date.
string
Include report periods strictly before this YYYY-MM-DD date.
string
Include report periods on or after this YYYY-MM-DD date.
string
Include report periods on or before this YYYY-MM-DD date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_GET_TREASURY_YIELD_CURVEReturn the latest US Treasury par yield curve or historical daily curves for a date range. Historical results are newest first and return one provider page.

Input Parameters

string ("current" | "historical")
Return the latest curve or historical daily curves.
string
Opaque continuation returned as next_cursor. Pass it alone without view, start_date, or end_date; a cursor-only request continues historical results.
string
Last historical date to include, in YYYY-MM-DD format.
string
First historical date to include, in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_DATASET_IDENTIFIERSList every ticker, CIK, or sector returned by one selected Financial Datasets data-family catalog.

Input Parameters

string ("institutional_holdings_tickers" | "index_fund_tickers" | "price_snapshot_tickers" | "financial_metric_snapshot_tickers" | "company_fact_tickers" | "company_fact_ciks" | "earnings_tickers" | "filing_tickers" | "filing_ciks" | "price_history_tickers" | "kpi_tickers" | "kpi_sectors")
required
Data family and identifier type whose accepted values to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_FILING_OPTIONSList supported SEC filing types or the documented section-selector catalog for filing extraction. The item catalog is not exhaustive: live 10-Q extraction accepted Part-1,Item-1 even though discovery omitted it.

Input Parameters

string
Optional filing type whose item-selector catalog to return, such as 10-K or 10-Q. Valid only when option_type is item_types.
string ("filing_types" | "item_types")
required
Return filing types or filing section/item selectors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_INSIDER_TRADESReturn one page of reported insider purchases, sales, gifts, awards, and other transactions for a company.

Input Parameters

string
Insider name to filter by.
integer
Total transaction rows requested across pages; provider default is 10.
string
Opaque continuation returned as next_cursor. When set, omit ticker and all filters, including limit.
string
Company ticker symbol. Required for the first page; omit when continuing with cursor.
string ("4" | "4/A" | "5" | "5/A")
SEC transaction form type: 4, 4/A, 5, or 5/A.
string
Require this exact filing date in YYYY-MM-DD format.
string
Only include filings strictly after this date in YYYY-MM-DD format.
string
Only include filings strictly before this date in YYYY-MM-DD format.
string
Only include filings on or after this date in YYYY-MM-DD format.
string
Only include filings on or before this date in YYYY-MM-DD format.
string
Provider transaction label, such as Open market sale or Gift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_IPOSReturn one page of IPO, SPAC, shell-company, resale, or other SEC offering filings with optional company and filing-date filters.

Input Parameters

string
Company SEC Central Index Key, with or without leading zeros.
integer
Total IPO rows requested across pages; provider default is 10.
string
Opaque continuation returned as next_cursor. When set, omit all other filters, including limit.
string
Proposed company ticker from the filing cover page.
string
Require this exact SEC filing date in YYYY-MM-DD format.
string ("ipo" | "shell_company" | "spac" | "resale" | "other")
Offering classification to return.
string
Only include filings strictly after this date in YYYY-MM-DD format.
string
Only include filings strictly before this date in YYYY-MM-DD format.
string
Only include filings on or after this date in YYYY-MM-DD format.
string
Only include filings on or before this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_MACRO_OPTIONSList valid central-bank codes or inflation, GPU price, and labor series IDs and metadata for macroeconomic queries.

Input Parameters

string ("inflation_series" | "central_banks" | "gpu_price_series" | "labor_series")
required
The macro selector catalog to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_NEWSReturn one page of recent company-specific or broad-market news articles.

Input Parameters

integer
Total number of articles requested across pages (1-10).
string
Continuation cursor returned by a prior call. When provided, the provider retains the original ticker and limit; omit those fields.
string
Company ticker symbol; omit to return broad-market news.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_SCREENER_FILTERSList all financial fields, company classifications, and comparison operators currently accepted by the company screener.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_LIST_SEC_FILINGSReturn one page of SEC filing metadata and source URLs with optional company and form filters.

Input Parameters

string
Company SEC Central Index Key (CIK) to filter filings.
integer
Total filing rows requested across all provider pages.
string
Opaque continuation returned as next_cursor. When set, omit ticker, CIK, filing_types, and limit because the cursor retains those filters.
string
Company ticker symbol to filter filings.
array
SEC filing types to include. Each value is sent as a repeated filing_type query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_SCREEN_COMPANIESFind companies whose financial fields, ticker, CIK, sector, or industry satisfy structured comparison filters.

Input Parameters

integer
Maximum number of matching companies to return (minimum 1).
array
required
One or more structured company-screening filters; all filters are applied together.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_SEARCH_FINANCIAL_LINE_ITEMSReturn selected financial line items for one or more company tickers and a reporting period type.

Input Parameters

integer
Maximum number of matching records to return (minimum 1).
string ("annual" | "quarterly" | "ttm")
Reporting period type for the financial data.
array
required
Company ticker symbols to query; provide at least one.
array
required
Financial metric names to return, such as revenue or net_income; provide at least one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FINANCIAL_DATASETS_AI_SEARCH_INSTITUTIONAL_INVESTORSFind institutional investor names and SEC CIKs by a case-insensitive name prefix, or omit name to return the provider’s discovery list.

Input Parameters

string
Case-insensitive investor-name prefix to search for; omit to return the provider’s discovery list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not