@bitget-ai/getagent-skill 0.2.1

package/skills/getagent/references/sdk/data/equity.md

@@ -0,0 +1,2120 @@
+# Equity Data Reference
+
+Use this file when an agent needs detailed signatures and parameter
+rules for one DataSDK domain. All generated `getagent.data` endpoints
+are callable through the DataSDK wrapper.
+
+## Contents
+- [`equity.calendar.dividend`](#equitycalendardividend)
+- [`equity.calendar.earnings`](#equitycalendarearnings)
+- [`equity.calendar.events`](#equitycalendarevents)
+- [`equity.calendar.ipo`](#equitycalendaripo)
+- [`equity.calendar.splits`](#equitycalendarsplits)
+- [`equity.compare.company_facts`](#equitycomparecompany-facts)
+- [`equity.compare.groups`](#equitycomparegroups)
+- [`equity.compare.peers`](#equitycomparepeers)
+- [`equity.darkpool.otc`](#equitydarkpoolotc)
+- [`equity.discovery.active`](#equitydiscoveryactive)
+- [`equity.discovery.aggressive_small_caps`](#equitydiscoveryaggressive-small-caps)
+- [`equity.discovery.filings`](#equitydiscoveryfilings)
+- [`equity.discovery.gainers`](#equitydiscoverygainers)
+- [`equity.discovery.growth_tech`](#equitydiscoverygrowth-tech)
+- [`equity.discovery.latest_financial_reports`](#equitydiscoverylatest-financial-reports)
+- [`equity.discovery.losers`](#equitydiscoverylosers)
+- [`equity.discovery.top_retail`](#equitydiscoverytop-retail)
+- [`equity.discovery.undervalued_growth`](#equitydiscoveryundervalued-growth)
+- [`equity.discovery.undervalued_large_caps`](#equitydiscoveryundervalued-large-caps)
+- [`equity.estimates.analyst_search`](#equityestimatesanalyst-search)
+- [`equity.estimates.consensus`](#equityestimatesconsensus)
+- [`equity.estimates.forward_ebitda`](#equityestimatesforward-ebitda)
+- [`equity.estimates.forward_eps`](#equityestimatesforward-eps)
+- [`equity.estimates.forward_pe`](#equityestimatesforward-pe)
+- [`equity.estimates.forward_sales`](#equityestimatesforward-sales)
+- [`equity.estimates.historical`](#equityestimateshistorical)
+- [`equity.estimates.price_target`](#equityestimatesprice-target)
+- [`equity.fundamental.balance`](#equityfundamentalbalance)
+- [`equity.fundamental.balance_growth`](#equityfundamentalbalance-growth)
+- [`equity.fundamental.cash`](#equityfundamentalcash)
+- [`equity.fundamental.cash_growth`](#equityfundamentalcash-growth)
+- [`equity.fundamental.dividends`](#equityfundamentaldividends)
+- [`equity.fundamental.employee_count`](#equityfundamentalemployee-count)
+- [`equity.fundamental.esg_score`](#equityfundamentalesg-score)
+- [`equity.fundamental.filings`](#equityfundamentalfilings)
+- [`equity.fundamental.historical_attributes`](#equityfundamentalhistorical-attributes)
+- [`equity.fundamental.historical_eps`](#equityfundamentalhistorical-eps)
+- [`equity.fundamental.historical_splits`](#equityfundamentalhistorical-splits)
+- [`equity.fundamental.income`](#equityfundamentalincome)
+- [`equity.fundamental.income_growth`](#equityfundamentalincome-growth)
+- [`equity.fundamental.latest_attributes`](#equityfundamentallatest-attributes)
+- [`equity.fundamental.management`](#equityfundamentalmanagement)
+- [`equity.fundamental.management_compensation`](#equityfundamentalmanagement-compensation)
+- [`equity.fundamental.management_discussion_analysis`](#equityfundamentalmanagement-discussion-analysis)
+- [`equity.fundamental.metrics`](#equityfundamentalmetrics)
+- [`equity.fundamental.ratios`](#equityfundamentalratios)
+- [`equity.fundamental.reported_financials`](#equityfundamentalreported-financials)
+- [`equity.fundamental.revenue_per_geography`](#equityfundamentalrevenue-per-geography)
+- [`equity.fundamental.revenue_per_segment`](#equityfundamentalrevenue-per-segment)
+- [`equity.fundamental.search_attributes`](#equityfundamentalsearch-attributes)
+- [`equity.fundamental.trailing_dividend_yield`](#equityfundamentaltrailing-dividend-yield)
+- [`equity.fundamental.transcript`](#equityfundamentaltranscript)
+- [`equity.historical_market_cap`](#equityhistorical-market-cap)
+- [`equity.market_snapshots`](#equitymarket-snapshots)
+- [`equity.ownership.form_13f`](#equityownershipform-13f)
+- [`equity.ownership.government_trades`](#equityownershipgovernment-trades)
+- [`equity.ownership.insider_trading`](#equityownershipinsider-trading)
+- [`equity.ownership.institutional`](#equityownershipinstitutional)
+- [`equity.ownership.major_holders`](#equityownershipmajor-holders)
+- [`equity.ownership.share_statistics`](#equityownershipshare-statistics)
+- [`equity.price.historical`](#equitypricehistorical)
+- [`equity.price.performance`](#equitypriceperformance)
+- [`equity.price.quote`](#equitypricequote)
+- [`equity.profile`](#equityprofile)
+- [`equity.screener`](#equityscreener)
+- [`equity.search`](#equitysearch)
+- [`equity.shorts.fails_to_deliver`](#equityshortsfails-to-deliver)
+- [`equity.shorts.short_interest`](#equityshortsshort-interest)
+
+## Endpoint reference
+
+### `equity.calendar.dividend`
+
+```python
+data.equity.calendar.dividend(start_time=None, end_time=None, provider=...)
+```
+
+Summary: Dividend
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.calendar.dividend` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/calendar/dividend` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `provider` | `yes` | `string` | `-` | enum: fmp, nasdaq |
+
+---
+
+### `equity.calendar.earnings`
+
+```python
+data.equity.calendar.earnings(start_time=None, end_time=None, symbol=None, country='us', provider=...)
+```
+
+Summary: Earnings
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.calendar.earnings` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/calendar/earnings` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
+| `country` | `no` | `string` | `us` | enum: us, ca The country to get calendar data for. Accepts 'us'/'ca', ISO codes ('US', 'USA', 'CA', 'CAN'), or names ('United States', 'Canada'). (provider: seeking_alpha) |
+| `provider` | `yes` | `string` | `-` | enum: finnhub, fmp, nasdaq, seeking_alpha, tmx |
+
+---
+
+### `equity.calendar.events`
+
+```python
+data.equity.calendar.events(start_time=None, end_time=None, country=None, provider='fmp')
+```
+
+Summary: Events
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.calendar.events` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/calendar/events` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `country` | `no` | `string | null` | `-` | Country code to filter economic events (e.g., 'US', 'JP', 'CN'). (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.calendar.ipo`
+
+```python
+data.equity.calendar.ipo(start_time=None, end_time=None, symbol=None, limit=100, status=None, min_value=None, max_value=None, is_spo=False, provider=...)
+```
+
+Summary: Ipo
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.calendar.ipo` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/calendar/ipo` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `100` | The number of data entries to return. |
+| `status` | `no` | `string | null` | `-` | Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio); The status of the IPO. (provider: nasdaq) |
+| `min_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) |
+| `max_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) |
+| `is_spo` | `no` | `boolean` | `false` | If True, returns data for secondary public offerings (SPOs). (provider: nasdaq) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq |
+
+---
+
+### `equity.calendar.splits`
+
+```python
+data.equity.calendar.splits(start_time=None, end_time=None, provider='fmp')
+```
+
+Summary: Splits
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.calendar.splits` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/calendar/splits` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.compare.company_facts`
+
+```python
+data.equity.compare.company_facts(symbol=None, fact='', year=None, fiscal_period=None, instantaneous=False, use_cache=True, provider='sec')
+```
+
+Summary: Company Facts
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.compare.company_facts` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/compare/company_facts` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): sec. |
+| `fact` | `no` | `string` | `` | The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.; Fact or concept from the SEC taxonomy, in UpperCamelCase. Defaults to, 'Revenues'. AAPL, MSFT, GOOG, BRK-A currently report revenue as, 'RevenueFromContractWithCustomerExcludingAssessedTax'. In previous years, they have reported as 'Revenues'. (provider: sec) |
+| `year` | `no` | `integer | null` | `-` | The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec) |
+| `fiscal_period` | `no` | `string | null` | `-` | The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec) |
+| `instantaneous` | `no` | `boolean` | `false` | Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data. The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec) |
+| `use_cache` | `no` | `boolean` | `true` | Whether to use cache for the request. Defaults to True. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `equity.compare.groups`
+
+```python
+data.equity.compare.groups(group='sector', metric='performance', provider='finviz')
+```
+
+Summary: Groups
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.compare.groups` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/compare/groups` |
+| Default provider | `finviz` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `group` | `no` | `string` | `sector` | enum: sector, industry, country, capitalization, energy, materials, industrials, consumer_cyclical, consumer_defensive, healthcare, financial, technology, communication_services, utilities, real_estate US-listed stocks only. When an individual sector is selected, it is broken down by industry. The default is 'sector'. (provider: finviz) |
+| `metric` | `no` | `string` | `performance` | enum: performance, valuation, overview Statistical metric to return. Select from: ['performance', 'valuation', 'overview'] The default is 'performance'. (provider: finviz) |
+| `provider` | `no` | `string` | `finviz` | - |
+
+---
+
+### `equity.compare.peers`
+
+```python
+data.equity.compare.peers(symbol=..., provider='fmp')
+```
+
+Summary: Peers
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.compare.peers` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/compare/peers` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.darkpool.otc`
+
+```python
+data.equity.darkpool.otc(symbol=None, tier='T1', is_ats=True, provider='finra')
+```
+
+Summary: Otc
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.darkpool.otc` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/darkpool/otc` |
+| Default provider | `finra` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
+| `tier` | `no` | `string` | `T1` | "T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities (provider: finra) |
+| `is_ats` | `no` | `boolean` | `true` | ATS data if true, NON-ATS otherwise (provider: finra) |
+| `provider` | `no` | `string` | `finra` | - |
+
+---
+
+### `equity.discovery.active`
+
+```python
+data.equity.discovery.active(sort='desc', limit=200, provider=...)
+```
+
+Summary: Active
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.active` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/active` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
+
+---
+
+### `equity.discovery.aggressive_small_caps`
+
+```python
+data.equity.discovery.aggressive_small_caps(sort='desc', limit=None, provider='yfinance')
+```
+
+Summary: Aggressive Small Caps
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.aggressive_small_caps` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/aggressive_small_caps` |
+| Default provider | `yfinance` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `-` | Limit the number of results. Default is all. (provider: yfinance) |
+| `provider` | `no` | `string` | `yfinance` | - |
+
+---
+
+### `equity.discovery.filings`
+
+```python
+data.equity.discovery.filings(start_time=None, end_time=None, form_type=None, limit=None, provider='fmp')
+```
+
+Summary: Filings
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.filings` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/filings` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `form_type` | `no` | `string | null` | `-` | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; The maximum number of results to return. Default is 10000. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.discovery.gainers`
+
+```python
+data.equity.discovery.gainers(sort='desc', category='price_performer', limit=200, provider=...)
+```
+
+Summary: Gainers
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.gainers` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/gainers` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `category` | `no` | `string` | `price_performer` | enum: dividend, energy, healthcare, industrials, price_performer, rising_stars, real_estate, tech, utilities, 52w_high, volume The category of list to retrieve. Defaults to `price_performer`. (provider: tmx) |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, tmx, yfinance |
+
+---
+
+### `equity.discovery.growth_tech`
+
+```python
+data.equity.discovery.growth_tech(sort='desc', limit=200, provider='yfinance')
+```
+
+Summary: Growth Tech
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.growth_tech` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/growth_tech` |
+| Default provider | `yfinance` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `no` | `string` | `yfinance` | - |
+
+---
+
+### `equity.discovery.latest_financial_reports`
+
+```python
+data.equity.discovery.latest_financial_reports(date=None, report_type=None, provider='sec')
+```
+
+Summary: Latest Financial Reports
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.latest_financial_reports` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/latest_financial_reports` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to today. (provider: sec) |
+| `report_type` | `no` | `string | null` | `-` | Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple comma separated items allowed. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `equity.discovery.losers`
+
+```python
+data.equity.discovery.losers(sort='desc', limit=200, provider=...)
+```
+
+Summary: Losers
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.losers` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/losers` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
+
+---
+
+### `equity.discovery.top_retail`
+
+```python
+data.equity.discovery.top_retail(limit=5, provider='nasdaq')
+```
+
+Summary: Top Retail
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.top_retail` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/top_retail` |
+| Default provider | `nasdaq` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `limit` | `no` | `integer` | `5` | The number of data entries to return. |
+| `provider` | `no` | `string` | `nasdaq` | - |
+
+---
+
+### `equity.discovery.undervalued_growth`
+
+```python
+data.equity.discovery.undervalued_growth(sort='desc', limit=200, provider='yfinance')
+```
+
+Summary: Undervalued Growth
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.undervalued_growth` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/undervalued_growth` |
+| Default provider | `yfinance` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `no` | `string` | `yfinance` | - |
+
+---
+
+### `equity.discovery.undervalued_large_caps`
+
+```python
+data.equity.discovery.undervalued_large_caps(sort='desc', limit=200, provider='yfinance')
+```
+
+Summary: Undervalued Large Caps
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.discovery.undervalued_large_caps` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/discovery/undervalued_large_caps` |
+| Default provider | `yfinance` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
+| `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
+| `provider` | `no` | `string` | `yfinance` | - |
+
+---
+
+### `equity.estimates.analyst_search`
+
+```python
+data.equity.estimates.analyst_search(analyst_name=None, firm_name=None, analyst_ids=None, firm_ids=None, limit=100, page=0, fields=None, provider='benzinga')
+```
+
+Summary: Analyst Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.analyst_search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/analyst_search` |
+| Default provider | `benzinga` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `analyst_name` | `no` | `string | null` | `-` | Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. |
+| `firm_name` | `no` | `string | null` | `-` | Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. |
+| `analyst_ids` | `no` | `string | null` | `-` | List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) |
+| `firm_ids` | `no` | `string | null` | `-` | Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga) |
+| `limit` | `no` | `integer | null` | `100` | Number of results returned. Limit 1000. (provider: benzinga) |
+| `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga) |
+| `fields` | `no` | `string | null` | `-` | Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) |
+| `provider` | `no` | `string` | `benzinga` | - |
+
+---
+
+### `equity.estimates.consensus`
+
+```python
+data.equity.estimates.consensus(symbol=None, industry_group_number=None, provider=...)
+```
+
+Summary: Consensus
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.consensus` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/consensus` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. |
+| `industry_group_number` | `no` | `integer | null` | `-` | The Zacks industry group number. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, tmx, yfinance |
+
+---
+
+### `equity.estimates.forward_ebitda`
+
+```python
+data.equity.estimates.forward_ebitda(symbol=None, fiscal_period='annual', limit=None, include_historical=False, estimate_type=None, provider=...)
+```
+
+Summary: Forward Ebitda
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.forward_ebitda` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/forward_ebitda` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
+| `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. (provider: fmp); Filter for only full-year or quarterly estimates. (provider: intrinio) |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. (provider: fmp) |
+| `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. (provider: fmp) |
+| `estimate_type` | `no` | `string | null` | `-` | Limit the EBITDA estimates to this type. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `equity.estimates.forward_eps`
+
+```python
+data.equity.estimates.forward_eps(symbol=None, fiscal_period='annual', limit=None, include_historical=False, fiscal_year=None, calendar_year=None, calendar_period=None, provider=...)
+```
+
+Summary: Forward Eps
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.forward_eps` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/forward_eps` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
+| `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. (provider: fmp, intrinio) |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. (provider: fmp) |
+| `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. (provider: fmp) |
+| `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
+| `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
+| `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `equity.estimates.forward_pe`
+
+```python
+data.equity.estimates.forward_pe(symbol=None, provider='intrinio')
+```
+
+Summary: Forward Pe
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.forward_pe` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/forward_pe` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.estimates.forward_sales`
+
+```python
+data.equity.estimates.forward_sales(symbol=None, fiscal_year=None, fiscal_period=None, calendar_year=None, calendar_period=None, provider='intrinio')
+```
+
+Summary: Forward Sales
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.forward_sales` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/forward_sales` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
+| `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
+| `fiscal_period` | `no` | `string | null` | `-` | The future fiscal period to retrieve estimates for. (provider: intrinio) |
+| `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
+| `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. (provider: intrinio) |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.estimates.historical`
+
+```python
+data.equity.estimates.historical(symbol=..., freq='quarterly', period='annual', limit=None, page=None, provider=...)
+```
+
+Summary: Historical
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.historical` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/historical` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `freq` | `no` | `string` | `quarterly` | enum: annual, quarterly The frequency of the data. Can be 'annual' or 'quarterly'. (provider: finnhub) |
+| `period` | `no` | `string` | `annual` | enum: quarter, annual Time period of the data to return. (provider: fmp) |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: fmp) |
+| `page` | `no` | `integer | null` | `-` | Page number for paginated results. Used with limit. (provider: fmp) |
+| `provider` | `yes` | `string` | `-` | enum: finnhub, fmp |
+
+---
+
+### `equity.estimates.price_target`
+
+```python
+data.equity.estimates.price_target(symbol=None, limit=None, start_time=None, end_time=None, page=0, date=None, updated=None, importance=None, action=None, analyst_ids=None, firm_ids=None, fields=None, provider=...)
+```
+
+Summary: Price Target
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.estimates.price_target` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/estimates/price_target` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters. (provider: benzinga) |
+| `date` | `no` | `string | null` | `-` | Date for calendar data, shorthand for date_from and date_to. (provider: benzinga) |
+| `updated` | `no` | `string | integer | null` | `-` | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD. (provider: benzinga) |
+| `importance` | `no` | `integer | null` | `-` | Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga) |
+| `action` | `no` | `string | null` | `-` | Filter by a specific action_company. (provider: benzinga) |
+| `analyst_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga) |
+| `firm_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga) |
+| `fields` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) |
+| `provider` | `yes` | `string` | `-` | enum: benzinga, finnhub, finviz, fmp |
+
+---
+
+### `equity.fundamental.balance`
+
+```python
+data.equity.fundamental.balance(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
+```
+
+Summary: Balance
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.balance` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/balance` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
+| `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
+
+---
+
+### `equity.fundamental.balance_growth`
+
+```python
+data.equity.fundamental.balance_growth(symbol=..., limit=None, period='annual', provider='fmp')
+```
+
+Summary: Balance Growth
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.balance_growth` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/balance_growth` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: fmp) |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.cash`
+
+```python
+data.equity.fundamental.cash(symbol=..., limit=5, period='annual', fiscal_year=None, provider=...)
+```
+
+Summary: Cash
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.cash` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/cash` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `5` | The number of data entries to return. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
+| `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
+
+---
+
+### `equity.fundamental.cash_growth`
+
+```python
+data.equity.fundamental.cash_growth(symbol=..., limit=None, period='annual', provider='fmp')
+```
+
+Summary: Cash Growth
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.cash_growth` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/cash_growth` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.dividends`
+
+```python
+data.equity.fundamental.dividends(symbol=..., start_time=None, end_time=None, limit=None, provider=...)
+```
+
+Summary: Dividends
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.dividends` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/dividends` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, nasdaq. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `limit` | `no` | `integer | null` | `-` | Return N most recent payments. (provider: fmp); The number of data entries to return. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq, tmx, yfinance |
+
+---
+
+### `equity.fundamental.employee_count`
+
+```python
+data.equity.fundamental.employee_count(symbol=..., start_time=None, end_time=None, limit=None, provider='fmp')
+```
+
+Summary: Employee Count
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.employee_count` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/employee_count` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `limit` | `no` | `integer | null` | `-` | Number of records to return. Default is all. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.esg_score`
+
+```python
+data.equity.fundamental.esg_score(symbol=..., provider='fmp')
+```
+
+Summary: Esg Score
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.esg_score` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/esg_score` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.filings`
+
+```python
+data.equity.fundamental.filings(symbol=None, start_time=None, end_time=None, cik=None, limit=1000, page=0, form_type=None, thea_enabled=None, year=None, form_group='8k', use_cache=True, provider=...)
+```
+
+Summary: Filings
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.filings` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/filings` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `cik` | `no` | `string | integer | null` | `-` | CIK number to look up. Overrides symbol. (provider: fmp); Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) |
+| `limit` | `no` | `integer | null` | `1000` | Number of results to return. Max results is 1000. (provider: fmp); The number of data entries to return. (provider: intrinio); The number of data entries to return. (provider: sec) |
+| `page` | `no` | `integer` | `0` | Page number for paginated results. Max page is 100. (provider: fmp) |
+| `form_type` | `no` | `string | null` | `-` | SEC form type to filter by. (provider: intrinio, sec) |
+| `thea_enabled` | `no` | `boolean | null` | `-` | Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) |
+| `year` | `no` | `integer | null` | `-` | Calendar year of the data, default is current year. The earliest year available is 1994, for all companies and form types. (provider: nasdaq) |
+| `form_group` | `no` | `string` | `8k` | enum: annual, quarterly, proxy, insider, 8k, registration, comment The form group to fetch, default is 8k. (provider: nasdaq) |
+| `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache. If True, cache will store for one day. (provider: sec) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq, sec, tmx |
+
+---
+
+### `equity.fundamental.historical_attributes`
+
+```python
+data.equity.fundamental.historical_attributes(symbol=..., tag=..., start_time=None, end_time=None, frequency='yearly', limit=1000, tag_type=None, sort='desc', provider='intrinio')
+```
+
+Summary: Historical Attributes
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.historical_attributes` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/historical_attributes` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
+| `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `frequency` | `no` | `string | null` | `yearly` | The frequency of the data. |
+| `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
+| `tag_type` | `no` | `string | null` | `-` | Filter by type, when applicable. |
+| `sort` | `no` | `string | null` | `desc` | Sort order. |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.fundamental.historical_eps`
+
+```python
+data.equity.fundamental.historical_eps(symbol=..., period='quarter', limit=None, provider=...)
+```
+
+Summary: Historical Eps
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.historical_eps` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/historical_eps` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, fmp. |
+| `period` | `no` | `string` | `quarter` | enum: annual, quarter Time period of the data to return. (provider: alpha_vantage) |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: alpha_vantage, fmp) |
+| `provider` | `yes` | `string` | `-` | enum: alpha_vantage, fmp |
+
+---
+
+### `equity.fundamental.historical_splits`
+
+```python
+data.equity.fundamental.historical_splits(symbol=..., provider='fmp')
+```
+
+Summary: Historical Splits
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.historical_splits` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/historical_splits` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.income`
+
+```python
+data.equity.fundamental.income(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
+```
+
+Summary: Income
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.income` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/income` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
+| `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
+
+---
+
+### `equity.fundamental.income_growth`
+
+```python
+data.equity.fundamental.income_growth(symbol=..., limit=None, period='annual', provider='fmp')
+```
+
+Summary: Income Growth
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.income_growth` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/income_growth` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.latest_attributes`
+
+```python
+data.equity.fundamental.latest_attributes(symbol=..., tag=..., provider='intrinio')
+```
+
+Summary: Latest Attributes
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.latest_attributes` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/latest_attributes` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
+| `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.fundamental.management`
+
+```python
+data.equity.fundamental.management(symbol=..., provider=...)
+```
+
+Summary: Management
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.management` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/management` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
+
+---
+
+### `equity.fundamental.management_compensation`
+
+```python
+data.equity.fundamental.management_compensation(symbol=..., year=-1, provider='fmp')
+```
+
+Summary: Management Compensation
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.management_compensation` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/management_compensation` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `year` | `no` | `integer` | `-1` | Filters results by year, enter 0 for all data available. Default is the most recent year in the dataset, -1. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.management_discussion_analysis`
+
+```python
+data.equity.fundamental.management_discussion_analysis(symbol=..., calendar_year=None, calendar_period=None, include_tables=True, use_cache=True, raw_html=False, provider='sec')
+```
+
+Summary: Management Discussion Analysis
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.management_discussion_analysis` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/management_discussion_analysis` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `calendar_year` | `no` | `integer | null` | `-` | Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report. |
+| `calendar_period` | `no` | `string | null` | `-` | Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report. |
+| `include_tables` | `no` | `boolean` | `true` | Return tables formatted as markdown in the text. Default is True. (provider: sec) |
+| `use_cache` | `no` | `boolean` | `true` | When True, the file will be cached for use later. Default is True. (provider: sec) |
+| `raw_html` | `no` | `boolean` | `false` | When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `equity.fundamental.metrics`
+
+```python
+data.equity.fundamental.metrics(symbol=..., ttm='only', period='annual', limit=None, provider=...)
+```
+
+Summary: Metrics
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.metrics` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/metrics` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance. |
+| `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. (provider: fmp) |
+| `period` | `no` | `string` | `annual` | enum: q1, q2, q3, q4, fy, annual, quarter Specify the fiscal period for the data. Ignored when TTM is set to 'only'. (provider: fmp) |
+| `limit` | `no` | `integer | null` | `-` | Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. (provider: fmp) |
+| `provider` | `yes` | `string` | `-` | enum: finviz, fmp, intrinio, yfinance |
+
+---
+
+### `equity.fundamental.ratios`
+
+```python
+data.equity.fundamental.ratios(symbol=..., limit=None, ttm='only', period='annual', fiscal_year=None, provider=...)
+```
+
+Summary: Ratios
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.ratios` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/ratios` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. (provider: fmp) |
+| `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. (provider: fmp) |
+| `period` | `no` | `string` | `annual` | Specify the fiscal period for the data. (provider: fmp); Time period of the data to return. (provider: intrinio) |
+| `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `equity.fundamental.reported_financials`
+
+```python
+data.equity.fundamental.reported_financials(symbol=..., period='annual', statement_type='balance', limit=100, fiscal_year=None, provider='intrinio')
+```
+
+Summary: Reported Financials
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.reported_financials` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/reported_financials` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. |
+| `statement_type` | `no` | `string` | `balance` | The type of financial statement - i.e, balance, income, cash.; Cash flow statements are reported as YTD, Q4 is the same as FY. (provider: intrinio) |
+| `limit` | `no` | `integer | null` | `100` | The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks. |
+| `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.fundamental.revenue_per_geography`
+
+```python
+data.equity.fundamental.revenue_per_geography(symbol=..., period='annual', provider='fmp')
+```
+
+Summary: Revenue Per Geography
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.revenue_per_geography` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_geography` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.revenue_per_segment`
+
+```python
+data.equity.fundamental.revenue_per_segment(symbol=..., period='annual', provider='fmp')
+```
+
+Summary: Revenue Per Segment
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.revenue_per_segment` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_segment` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.fundamental.search_attributes`
+
+```python
+data.equity.fundamental.search_attributes(query=..., limit=1000, provider='intrinio')
+```
+
+Summary: Search Attributes
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.search_attributes` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/search_attributes` |
+| Default provider | `intrinio` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `yes` | `string` | `-` | Query to search for. |
+| `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
+| `provider` | `no` | `string` | `intrinio` | - |
+
+---
+
+### `equity.fundamental.trailing_dividend_yield`
+
+```python
+data.equity.fundamental.trailing_dividend_yield(symbol=..., limit=252, provider='tiingo')
+```
+
+Summary: Trailing Dividend Yield
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.trailing_dividend_yield` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/trailing_dividend_yield` |
+| Default provider | `tiingo` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `252` | The number of data entries to return. Default is 252, the number of trading days in a year. |
+| `provider` | `no` | `string` | `tiingo` | - |
+
+---
+
+### `equity.fundamental.transcript`
+
+```python
+data.equity.fundamental.transcript(symbol=..., year=None, quarter=None, provider='fmp')
+```
+
+Summary: Transcript
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.fundamental.transcript` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/fundamental/transcript` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `year` | `no` | `integer | null` | `-` | Year of the earnings call transcript. |
+| `quarter` | `no` | `integer | null` | `-` | Quarterly period of the earnings call transcript. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.historical_market_cap`
+
+```python
+data.equity.historical_market_cap(symbol=..., start_time=None, end_time=None, interval='day', provider=...)
+```
+
+Summary: Historical Market Cap
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.historical_market_cap` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/historical_market_cap` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `interval` | `no` | `string` | `day` | enum: day, week, month, quarter, year None |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `equity.market_snapshots`
+
+```python
+data.equity.market_snapshots(market='nasdaq', date=None, provider=...)
+```
+
+Summary: Market Snapshots
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.market_snapshots` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/market_snapshots` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `market` | `no` | `string` | `nasdaq` | enum: amex, ams, ase, asx, ath, bme, bru, bud, bue, cai, cnq, commodity, cph, crypto, dfm, doh, dus, etf, euronext, forex, hel, hkse, ice, iob, index, ist, jkt, jnb, jpx, kls, koe, ksc, kuw, lse, mex, mil, mutual_fund, nasdaq, neo, nse, nyse, nze, osl, otc, pnk, pra, ris, sao, sau, ses, set, sgo, shh, shz, six, sto, tai, tlv, tsx, two, vie, wse, xetra The market to fetch data for. (provider: fmp) |
+| `date` | `no` | `string | null` | `-` | The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
+
+---
+
+### `equity.ownership.form_13f`
+
+```python
+data.equity.ownership.form_13f(symbol=..., date=None, limit=1, provider='sec')
+```
+
+Summary: Form 13F
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.form_13f` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/form_13f` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. A CIK can be used. |
+| `date` | `no` | `string | null` | `-` | A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported. |
+| `limit` | `no` | `integer | null` | `1` | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `equity.ownership.government_trades`
+
+```python
+data.equity.ownership.government_trades(symbol=None, chamber='all', limit=None, provider='fmp')
+```
+
+Summary: Government Trades
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.government_trades` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/government_trades` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `chamber` | `no` | `string` | `all` | Government Chamber. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.ownership.insider_trading`
+
+```python
+data.equity.ownership.insider_trading(symbol=..., limit=None, start_time=None, end_time=None, transaction_type=None, statistics=False, ownership_type=None, sort_by='updated_on', use_cache=True, summary=False, provider=...)
+```
+
+Summary: Insider Trading
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.insider_trading` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/insider_trading` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `transaction_type` | `no` | `string | null` | `-` | Type of the transaction. (provider: fmp) |
+| `statistics` | `no` | `boolean` | `false` | Flag to return summary statistics for the given symbol. Setting as True will ignore other parameters except symbol. (provider: fmp) |
+| `ownership_type` | `no` | `string | null` | `-` | Type of ownership. (provider: intrinio) |
+| `sort_by` | `no` | `string | null` | `updated_on` | Field to sort by. (provider: intrinio) |
+| `use_cache` | `no` | `boolean` | `true` | Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times. (provider: sec) |
+| `summary` | `no` | `boolean` | `false` | Return a summary of the insider activity instead of the individuals. (provider: tmx) |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, sec, tmx |
+
+---
+
+### `equity.ownership.institutional`
+
+```python
+data.equity.ownership.institutional(symbol=..., year=None, quarter=None, provider='fmp')
+```
+
+Summary: Institutional
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.institutional` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/institutional` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
+| `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. (provider: fmp) |
+| `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.ownership.major_holders`
+
+```python
+data.equity.ownership.major_holders(symbol=..., year=None, quarter=None, page=None, limit=None, provider='fmp')
+```
+
+Summary: Major Holders
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.major_holders` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/major_holders` |
+| Default provider | `fmp` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. (provider: fmp) |
+| `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. (provider: fmp) |
+| `page` | `no` | `integer | null` | `-` | Page number, used in conjunction with the limit. The default is 0. (provider: fmp) |
+| `limit` | `no` | `integer | null` | `-` | Number of items to return per page. The default is 100, which is the maximum. (provider: fmp) |
+| `provider` | `no` | `string` | `fmp` | - |
+
+---
+
+### `equity.ownership.share_statistics`
+
+```python
+data.equity.ownership.share_statistics(symbol=..., provider=...)
+```
+
+Summary: Share Statistics
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.ownership.share_statistics` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/ownership/share_statistics` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, yfinance. |
+| `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
+
+---
+
+### `equity.price.historical`
+
+```python
+data.equity.price.historical(symbol=..., start_time=None, end_time=None, interval='daily', market='a_share', adjust='qfq', adjustment='splits_only', extended_hours=False, use_cache=True, start_clock_time=None, end_clock_time=None, timezone='America/New_York', source='realtime', include_actions=True, provider=...)
+```
+
+Summary: Historical
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.price.historical` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/price/historical` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, alpha_vantage, cboe, fmp, tiingo, tmx, tradier, yfinance.; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). (provider: intrinio) |
+| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
+| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
+| `interval` | `no` | `string | integer` | `daily` | Data granularity: daily, weekly, or monthly. (provider: akshare); Time interval of the data to return. (provider: alpha_vantage); Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals. (provider: cboe); Time interval of the data to return. (provider: fmp); Time interval of the data to return. (provider: intrinio); Time interval of the data to return. (provider: tiingo); Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022. (provider: tmx); Time interval of the data to return. (provider: tradier); Time interval of the data to return. (provider: yfinance) |
+| `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. (provider: akshare) |
+| `adjust` | `no` | `string` | `qfq` | enum: , qfq, hfq Price adjustment method. '' for unadjusted, 'qfq' for forward-adjusted (前复权), 'hfq' for backward-adjusted (后复权). (provider: akshare) |
+| `adjustment` | `no` | `string` | `splits_only` | The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); Type of adjustment for historical prices. Only applies to daily data. (provider: fmp); The adjustment factor to apply. Only valid for daily data. (provider: tmx); The adjustment factor to apply. Default is splits only. (provider: yfinance) |
+| `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. (provider: alpha_vantage,tradier, yfinance) |
+| `use_cache` | `no` | `boolean` | `true` | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) |
+| `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
+| `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
+| `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) |
+| `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. (provider: intrinio) |
+| `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. (provider: yfinance) |
+| `provider` | `yes` | `string` | `-` | enum: akshare, alpha_vantage, cboe, finnhub, fmp, intrinio, tiingo, tmx, tradier, yfinance |
+
+---
+
+### `equity.price.performance`
+
+```python
+data.equity.price.performance(symbol=..., provider=...)
+```
+
+Summary: Performance
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.price.performance` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/price/performance` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp. |
+| `provider` | `yes` | `string` | `-` | enum: finviz, fmp |
+
+---
+
+### `equity.price.quote`
+
+```python
+data.equity.price.quote(symbol=..., market='a_share', use_cache=True, source='iex', provider=...)
+```
+
+Summary: Quote
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.price.quote` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/price/quote` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, cboe, fmp, intrinio, tmx, tradier, yfinance.; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). (provider: intrinio) |
+| `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. (provider: akshare) |
+| `use_cache` | `no` | `boolean` | `true` | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) |
+| `source` | `no` | `string` | `iex` | enum: iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, intrinio_mx, intrinio_mx_plus, delayed_sip Source of the data. (provider: intrinio) |
+| `provider` | `yes` | `string` | `-` | enum: akshare, cboe, finnhub, fmp, intrinio, tmx, tradier, yfinance |
+
+---
+
+### `equity.profile`
+
+```python
+data.equity.profile(symbol=..., provider=...)
+```
+
+Summary: Profile
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.profile` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/profile` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, finviz, fmp, intrinio, tmx, yfinance. |
+| `provider` | `yes` | `string` | `-` | enum: akshare, finnhub, finviz, fmp, intrinio, tmx, yfinance |
+
+---
+
+### `equity.screener`
+
+```python
+data.equity.screener(metric='overview', exchange='all', index='all', sector='all', industry='all', mktcap='all', recommendation='all', signal=None, preset=None, limit=None, mktcap_min=None, mktcap_max=None, price_min=None, price_max=None, beta_min=None, beta_max=None, volume_min=None, volume_max=None, dividend_min=None, dividend_max=None, country=None, is_etf=None, is_active=None, is_fund=None, all_share_classes=None, exsubcategory='all', region='all', provider=..., body=...)
+```
+
+Summary: Screener
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.screener` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/screener` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `metric` | `no` | `string` | `overview` | enum: overview, valuation, financial, ownership, performance, technical The data group to return, default is 'overview'. (provider: finviz) |
+| `exchange` | `no` | `string | null` | `all` | Filter by exchange. (provider: finviz,fmp,nasdaq, yfinance) |
+| `index` | `no` | `string` | `all` | enum: all, dow, nasdaq, sp500, russell Filter by index. (provider: finviz) |
+| `sector` | `no` | `string | null` | `all` | Filter by sector. (provider: finviz,fmp,nasdaq, yfinance) |
+| `industry` | `no` | `string | null` | `all` | Filter by industry. (provider: finviz,fmp, yfinance) |
+| `mktcap` | `no` | `string` | `all` | Filter by market cap. Mega - > 200B Large - 10B - 200B Mid - 2B - 10B Small - 300M - 2B Micro - 50M - 300M Nano - < 50M (provider: finviz, nasdaq) |
+| `recommendation` | `no` | `string` | `all` | Filter by analyst recommendation. (provider: finviz); Filter by consensus analyst action. Multiple comma separated items allowed. (provider: nasdaq) |
+| `signal` | `no` | `string | null` | `-` | The Finviz screener signal to use. When no parameters are provided, the screener defaults to 'top_gainers'. Available signals are: channel: both support and resistance trendlines are horizontal channel_down: both support and resistance trendlines slope downward channel_up: both support and resistance trendlines slope upward double_bottom: stock with 'W' shape that indicates a bullish reversal in trend double_top: stock with 'M' shape that indicates a bearish reversal in trend downgrades: stocks downgraded by analysts today earnings_after: companies reporting earnings today, after market close earnings_before: companies reporting earnings today, before market open head_shoulders: chart formation that predicts a bullish-to-bearish trend reversal head_shoulders_inverse: chart formation that predicts a bearish-to-bullish trend reversal horizontal_sr: horizontal channel of price range between support and resistance trendlines major_news: stocks with the highest news coverage today most_active: stocks with the highest trading volume today most_volatile: stocks with the highest widest high/low trading range today multiple_bottom: same as double_bottom hitting more lows multiple_top: same as double_top hitting more highs new_high: stocks making 52-week high today new_low: stocks making 52-week low today overbought: stock is becoming overvalued and may experience a pullback. oversold: oversold stocks may represent a buying opportunity for investors recent_insider_buying: stocks with recent insider buying activity recent_insider_selling: stocks with recent insider selling activity tl_resistance: once a rising trendline is broken tl_support: once a falling trendline is broken top_gainers: stocks with the highest price gain percent today top_losers: stocks with the highest price percent loss today triangle_ascending: upward trendline support and horizontal trendline resistance triangle_descending: horizontal trendline support and downward trendline resistance unusual_volume: stocks with unusually high volume today - the highest relative volume ratio upgrades: stocks upgraded by analysts today wedge: upward trendline support, downward trendline resistance (continuation) wedge_down: downward trendline support and downward trendline resistance (reversal) wedge_up: upward trendline support and upward trendline resistance (reversal) (provider: finviz) |
+| `preset` | `no` | `string | null` | `-` | A configured preset file to use for the query. This overrides all other query parameters except 'metric', and 'limit'. Presets (.ini text files) can be created and modified in the '~/OpenBBUserData/finviz/presets' directory. If the path does not exist, it will be created and populated with the default presets on the first run. Refer to the file, 'screener_template.ini', for the format and options. Note: Syntax of parameters in preset files must follow the template file exactly - i.e, Analyst Recom. = Strong Buy (1) (provider: finviz) |
+| `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: finviz); Limit the number of results to return. (provider: fmp); Limit the number of results to return. (provider: nasdaq); Limit the number of results returned. Default is, 200. Set to, 0, for all results. (provider: yfinance) |
+| `mktcap_min` | `no` | `integer | null` | `-` | Filter by market cap greater than this value. (provider: fmp, yfinance) |
+| `mktcap_max` | `no` | `integer | null` | `-` | Filter by market cap less than this value. (provider: fmp, yfinance) |
+| `price_min` | `no` | `number | null` | `-` | Filter by price greater than this value. (provider: fmp, yfinance) |
+| `price_max` | `no` | `number | null` | `-` | Filter by price less than this value. (provider: fmp, yfinance) |
+| `beta_min` | `no` | `number | null` | `-` | Filter by a beta greater than this value. (provider: fmp, yfinance) |
+| `beta_max` | `no` | `number | null` | `-` | Filter by a beta less than this value. (provider: fmp, yfinance) |
+| `volume_min` | `no` | `integer | null` | `-` | Filter by volume greater than this value. (provider: fmp, yfinance) |
+| `volume_max` | `no` | `integer | null` | `-` | Filter by volume less than this value. (provider: fmp, yfinance) |
+| `dividend_min` | `no` | `number | null` | `-` | Filter by dividend amount greater than this value. (provider: fmp) |
+| `dividend_max` | `no` | `number | null` | `-` | Filter by dividend amount less than this value. (provider: fmp) |
+| `country` | `no` | `string | null` | `-` | Filter by country. Accepts ISO 3166-1 alpha-2 codes (e.g., 'US', 'DE'), alpha-3 codes (e.g., 'USA'), or country names (e.g., 'United States', 'united_states'). (provider: fmp,nasdaq, yfinance) |
+| `is_etf` | `no` | `boolean | null` | `-` | If true, includes ETFs. (provider: fmp) |
+| `is_active` | `no` | `boolean | null` | `-` | If false, returns only inactive tickers. (provider: fmp) |
+| `is_fund` | `no` | `boolean | null` | `-` | If true, includes funds. (provider: fmp) |
+| `all_share_classes` | `no` | `boolean | null` | `-` | If true, includes all share classes of a equity. (provider: fmp) |
+| `exsubcategory` | `no` | `string` | `all` | Filter by exchange subcategory. - NGS - Nasdaq Global Select Market - NGM - Nasdaq Global Market - NCM - Nasdaq Capital Market - ADR - American Depository Receipt Multiple comma separated items allowed. (provider: nasdaq) |
+| `region` | `no` | `string` | `all` | Filter by region. Multiple comma separated items allowed. (provider: nasdaq) |
+| `provider` | `yes` | `string` | `-` | enum: finviz, fmp, nasdaq, yfinance |
+| `body` | `no` | `object | string | null` | `-` | A formatted dictionary, or serialized JSON string, of additional filters to apply to the query. This parameter can be used as an alternative to preset files, and is ignored when a preset is supplied. Invalid entries will raise an error. Syntax should follow the 'screener_template.ini' file. (provider: finviz) |
+
+---
+
+### `equity.search`
+
+```python
+data.equity.search(query='', is_symbol=False, use_cache=True, active=True, limit=10000, is_etf=False, is_fund=False, provider=...)
+```
+
+Summary: Search
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.search` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/search` |
+| Default provider | - |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `query` | `no` | `string` | `` | Search query. |
+| `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol.; Whether the query is a symbol. Defaults to False. (provider: tradier) |
+| `use_cache` | `no` | `boolean` | `true` | Whether to use the cache or not. (provider: cboe, sec); Whether to use a cached request. The list of companies is cached for two days. (provider: tmx) |
+| `active` | `no` | `boolean` | `true` | When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. (provider: intrinio) |
+| `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. (provider: intrinio) |
+| `is_etf` | `no` | `boolean` | `false` | If True, returns only ETFs. (provider: nasdaq) |
+| `is_fund` | `no` | `boolean` | `false` | Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) |
+| `provider` | `yes` | `string` | `-` | enum: cboe, intrinio, nasdaq, sec, tmx, tradier |
+
+---
+
+### `equity.shorts.fails_to_deliver`
+
+```python
+data.equity.shorts.fails_to_deliver(symbol=..., limit=24, skip_reports=0, use_cache=True, provider='sec')
+```
+
+Summary: Fails To Deliver
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.shorts.fails_to_deliver` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/shorts/fails_to_deliver` |
+| Default provider | `sec` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `limit` | `no` | `integer | null` | `24` | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. (provider: sec) |
+| `skip_reports` | `no` | `integer | null` | `0` | Skip N number of reports from current. A value of 1 will skip the most recent report. (provider: sec) |
+| `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec) |
+| `provider` | `no` | `string` | `sec` | - |
+
+---
+
+### `equity.shorts.short_interest`
+
+```python
+data.equity.shorts.short_interest(symbol=..., provider='finra')
+```
+
+Summary: Short Interest
+
+| Field | Value |
+|---|---|
+| Endpoint ID | `equity.shorts.short_interest` |
+| HTTP | `GET` |
+| Path | `/inner/v1/agent-data/equity/shorts/short_interest` |
+| Default provider | `finra` |
+| SDK | `supported` |
+| Host | `supported` |
+| Notes | - |
+
+#### Query parameters
+
+| Param | Required | Type | Default | Notes |
+|---|---|---|---|---|
+| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
+| `provider` | `no` | `string` | `finra` | - |