---
canonical_url: "https://docs.composio.dev/toolkits/financial_datasets_ai"
markdown_url: "https://docs.composio.dev/toolkits/financial_datasets_ai.md"
product: "platform"
version: null
last_updated: null
---

# Financial Datasets

Access company fundamentals, financial statements, market data, SEC filings, ownership data, macroeconomic series, and financial analytics.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 30
- **Triggers:** 0
- **Slug:** `FINANCIAL_DATASETS_AI`
- **Version:** 00000000_00

## Tools

### Get As-Reported Financials

**Slug:** `FINANCIAL_DATASETS_AI_GET_AS_REPORTED_FINANCIALS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Beneficial Ownership

**Slug:** `FINANCIAL_DATASETS_AI_GET_BENEFICIAL_OWNERSHIP`

Return one page of current or historical SEC Schedule 13D and 13G stakes by subject ticker or beneficial-owner CIK.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Facts

**Slug:** `FINANCIAL_DATASETS_AI_GET_COMPANY_FACTS`

Return a company's identity, classification, exchange, and active-status facts by ticker or SEC CIK.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | Company SEC Central Index Key (CIK). Provide exactly one of cik or ticker. |
| `ticker` | string | No | Company ticker symbol. Provide exactly one of ticker or cik. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company KPIs

**Slug:** `FINANCIAL_DATASETS_AI_GET_COMPANY_KPIS`

Return one page of reported operating KPIs, forward guidance, or non-GAAP metrics for a company, including source provenance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Total periods requested across provider pages (1-50). |
| `cursor` | string | No | 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. |
| `period` | string ("quarterly" | "annual") | No | Reporting period type. |
| `ticker` | string | No | Company ticker symbol. Required on the first page; omit with cursor. |
| `data_type` | string ("reported" | "guidance" | "non_gaap") | No | KPI family to return: reported operating metrics, forward guidance, or non-GAAP metrics. |
| `metric_name` | string | No | Restrict results to one provider-defined metric name. |
| `report_period_gte` | string | No | Return records on or after this date in YYYY-MM-DD format. |
| `report_period_lte` | string | No | Return records on or before this date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Earnings

**Slug:** `FINANCIAL_DATASETS_AI_GET_EARNINGS`

Return one page of recent company earnings filings with quarterly and annual financial metrics, detected signals, and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 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. |
| `cursor` | string | No | Exact next_cursor URL returned by a prior call. Pass it back unchanged and omit ticker and limit; it retains the original request filters. |
| `ticker` | string | No | Company ticker symbol. Required on the first page; omit with cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Financial Metrics

**Slug:** `FINANCIAL_DATASETS_AI_GET_FINANCIAL_METRICS`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | Company SEC CIK. Provide exactly one of cik or ticker unless continuing with cursor. |
| `view` | string ("current" | "historical") | No | Return the latest metrics snapshot or one page of historical metric records. Historical-only filters are rejected for current view. |
| `limit` | integer | No | Total metric records requested across all pages. Provider pages contain up to 10 records. |
| `cursor` | string | No | 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. |
| `period` | string ("annual" | "quarterly" | "ttm") | No | Historical reporting period type. Required for an initial historical request. |
| `ticker` | string | No | Company ticker. Provide exactly one of ticker or cik unless continuing with cursor. |
| `filing_date` | string | No | Require this exact SEC filing date. Rows without a known filing date are excluded. |
| `report_period` | string | No | Require this exact report period in YYYY-MM-DD format. |
| `filing_date_gt` | string | No | Return rows filed strictly after this date; rows without a known filing date are excluded. |
| `filing_date_lt` | string | No | Return rows filed strictly before this date; rows without a known filing date are excluded. |
| `filing_date_gte` | string | No | Return rows filed on or after this date; rows without a known filing date are excluded. |
| `filing_date_lte` | string | No | Return rows filed on or before this date for point-in-time research; rows without a known filing date are excluded. |
| `report_period_gt` | string | No | Return report periods strictly after this date. |
| `report_period_lt` | string | No | Return report periods strictly before this date. |
| `report_period_gte` | string | No | Return report periods on or after this date. |
| `report_period_lte` | string | No | Return report periods on or before this date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Financial Statements

**Slug:** `FINANCIAL_DATASETS_AI_GET_FINANCIAL_STATEMENTS`

Return one provider page of normalized income statements, balance sheets, cash-flow statements, or all three for a company.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GPU Prices

**Slug:** `FINANCIAL_DATASETS_AI_GET_GPU_PRICES`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("current" | "historical") | No | Return today's GPU prices or one page of historical daily prices. |
| `cursor` | string | No | Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit view, series, start_date, and end_date. |
| `series` | string | No | 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. |
| `end_date` | string | No | Last historical UTC day to include, in YYYY-MM-DD format. |
| `start_date` | string | No | First historical UTC day to include, in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Index Fund Holdings

**Slug:** `FINANCIAL_DATASETS_AI_GET_INDEX_FUND_HOLDINGS`

Return one page of a fund's constituents by fund ticker, or one page of funds containing a security by holding ticker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `as_of` | string | No | For ticker searches only, return the fund composition in effect on or before this YYYY-MM-DD date. |
| `limit` | integer | No | Total rows requested across all provider pages. Each page contains at most 10 rows; the provider documents no maximum total. |
| `cursor` | string | No | 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. |
| `offset` | integer | No | Rows to skip on the initial request. Prefer cursor for continuation. |
| `ticker` | string | No | Fund ticker whose constituents to return. Provide exactly one of ticker or holding on the first page. |
| `holding` | string | No | Held-security ticker used to find funds containing it. Provide exactly one of holding or ticker on the first page. |
| `asset_class` | string ("equity" | "bond") | No | For ticker searches only, restrict constituents to equity or bond holdings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inflation

**Slug:** `FINANCIAL_DATASETS_AI_GET_INFLATION`

Return the latest CPI values for all or one inflation series, or monthly history for one series.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Insider Ownership

**Slug:** `FINANCIAL_DATASETS_AI_GET_INSIDER_OWNERSHIP`

Return one page of company insider holdings reported on SEC Forms 3 and 5, including common and derivative positions.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Institutional Holdings

**Slug:** `FINANCIAL_DATASETS_AI_GET_INSTITUTIONAL_HOLDINGS`

Return one page of SEC 13F holdings by institution CIK or held-company ticker.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Interest Rates

**Slug:** `FINANCIAL_DATASETS_AI_GET_INTEREST_RATES`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bank` | string | No | Central bank code, such as FED, ECB, or BOJ. Required unless cursor is provided. Use List Macro Options to discover supported codes. |
| `view` | string ("historical" | "current") | No | Return the current policy rate or historical rate observations. |
| `cursor` | string | No | Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit bank, view, start_date, and end_date. |
| `end_date` | string | No | Last historical date to include, in YYYY-MM-DD format. Historical results default to today when omitted. |
| `start_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Labor Market

**Slug:** `FINANCIAL_DATASETS_AI_GET_LABOR_MARKET`

Return the latest print for all or one US labor series, or one page of historical monthly or weekly observations for one series.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("current" | "historical") | No | Return the latest labor prints or one page of historical observations. |
| `cursor` | string | No | Exact next_cursor URL returned by a historical call. Pass it back unchanged and omit view, series, start_date, and end_date. |
| `series` | string | No | 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. |
| `end_date` | string | No | Last historical period to include, in YYYY-MM-DD format. |
| `start_date` | string | No | First historical period to include, in YYYY-MM-DD format. Any day in a month selects that month for monthly series. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Price History

**Slug:** `FINANCIAL_DATASETS_AI_GET_PRICE_HISTORY`

Return one page of historical OHLCV stock prices for an inclusive date range at a daily, weekly, monthly, or yearly interval.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Price Snapshot

**Slug:** `FINANCIAL_DATASETS_AI_GET_PRICE_SNAPSHOT`

Return a real-time price snapshot for one ticker or snapshots for the broad market.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SEC Filing Items

**Slug:** `FINANCIAL_DATASETS_AI_GET_SEC_FILING_ITEMS`

Extract 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item` | string | No | 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. |
| `year` | integer | Yes | Calendar year of the filing. |
| `ticker` | string | Yes | Company ticker symbol. |
| `quarter` | integer | No | Fiscal quarter, normally needed to identify a 10-Q filing. |
| `filing_type` | string ("10-K" | "10-Q" | "8-K") | Yes | SEC filing type to extract. |
| `accession_number` | string | No | Exact SEC accession number when the year and filing type are ambiguous. |
| `include_exhibits` | boolean | No | Include linked exhibit text for an 8-K filing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmented Financials

**Slug:** `FINANCIAL_DATASETS_AI_GET_SEGMENTED_FINANCIALS`

Return one page of company-reported business or product segments for one statement family or all statements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cik` | string | No | Company SEC Central Index Key. Provide exactly one of cik or ticker on the first page. |
| `limit` | integer | No | Total segmented-financial records requested across provider pages. |
| `cursor` | string | No | 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. |
| `period` | string ("annual" | "quarterly") | No | Reporting period type. Required on the first page; segmented financials do not support TTM. |
| `ticker` | string | No | Company ticker symbol. Provide exactly one of ticker or cik on the first page. |
| `report_period` | string | No | Require this exact report period in YYYY-MM-DD format. |
| `statement_type` | string ("income" | "balance_sheet" | "cash_flow" | "all") | No | Statement family whose reported segments to return. |
| `report_period_gt` | string | No | Include report periods strictly after this YYYY-MM-DD date. |
| `report_period_lt` | string | No | Include report periods strictly before this YYYY-MM-DD date. |
| `report_period_gte` | string | No | Include report periods on or after this YYYY-MM-DD date. |
| `report_period_lte` | string | No | Include report periods on or before this YYYY-MM-DD date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Treasury Yield Curve

**Slug:** `FINANCIAL_DATASETS_AI_GET_TREASURY_YIELD_CURVE`

Return 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Identifiers

**Slug:** `FINANCIAL_DATASETS_AI_LIST_DATASET_IDENTIFIERS`

List every ticker, CIK, or sector returned by one selected Financial Datasets data-family catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset` | 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") | Yes | Data family and identifier type whose accepted values to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Filing Options

**Slug:** `FINANCIAL_DATASETS_AI_LIST_FILING_OPTIONS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filing_type` | string | No | Optional filing type whose item-selector catalog to return, such as 10-K or 10-Q. Valid only when option_type is item_types. |
| `option_type` | string ("filing_types" | "item_types") | Yes | Return filing types or filing section/item selectors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Insider Trades

**Slug:** `FINANCIAL_DATASETS_AI_LIST_INSIDER_TRADES`

Return one page of reported insider purchases, sales, gifts, awards, and other transactions for a company.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List IPO Filings

**Slug:** `FINANCIAL_DATASETS_AI_LIST_IPOS`

Return one page of IPO, SPAC, shell-company, resale, or other SEC offering filings with optional company and filing-date filters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Macro Options

**Slug:** `FINANCIAL_DATASETS_AI_LIST_MACRO_OPTIONS`

List valid central-bank codes or inflation, GPU price, and labor series IDs and metadata for macroeconomic queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `option_type` | string ("inflation_series" | "central_banks" | "gpu_price_series" | "labor_series") | Yes | The macro selector catalog to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List News

**Slug:** `FINANCIAL_DATASETS_AI_LIST_NEWS`

Return one page of recent company-specific or broad-market news articles.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Screener Filters

**Slug:** `FINANCIAL_DATASETS_AI_LIST_SCREENER_FILTERS`

List all financial fields, company classifications, and comparison operators currently accepted by the company screener.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SEC Filings

**Slug:** `FINANCIAL_DATASETS_AI_LIST_SEC_FILINGS`

Return one page of SEC filing metadata and source URLs with optional company and form filters.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Screen Companies

**Slug:** `FINANCIAL_DATASETS_AI_SCREEN_COMPANIES`

Find companies whose financial fields, ticker, CIK, sector, or industry satisfy structured comparison filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of matching companies to return (minimum 1). |
| `filters` | array | Yes | One or more structured company-screening filters; all filters are applied together. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Financial Line Items

**Slug:** `FINANCIAL_DATASETS_AI_SEARCH_FINANCIAL_LINE_ITEMS`

Return selected financial line items for one or more company tickers and a reporting period type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of matching records to return (minimum 1). |
| `period` | string ("annual" | "quarterly" | "ttm") | No | Reporting period type for the financial data. |
| `tickers` | array | Yes | Company ticker symbols to query; provide at least one. |
| `line_items` | array | Yes | Financial metric names to return, such as revenue or net_income; provide at least one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Institutional Investors

**Slug:** `FINANCIAL_DATASETS_AI_SEARCH_INSTITUTIONAL_INVESTORS`

Find institutional investor names and SEC CIKs by a case-insensitive name prefix, or omit name to return the provider's discovery list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Case-insensitive investor-name prefix to search for; omit to return the provider's discovery list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |