Equity Screener

---

Implementation details

Class names

Model name	Parameters class	Data class
EquityScreener	EquityScreenerQueryParams	EquityScreenerData

Import Statement

from openbb_core.provider.standard_models.equity_screener import (
EquityScreenerData,
EquityScreenerQueryParams,
)

---

Parameters

• standard
• fmp

Name	Type	Description	Default	Optional
provider	Literal['fmp']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.	fmp	True

Name	Type	Description	Default	Optional
provider	Literal['fmp']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.	fmp	True
mktcap_min	int	Filter by market cap greater than this value.	None	True
mktcap_max	int	Filter by market cap less than this value.	None	True
price_min	float	Filter by price greater than this value.	None	True
price_max	float	Filter by price less than this value.	None	True
beta_min	float	Filter by a beta greater than this value.	None	True
beta_max	float	Filter by a beta less than this value.	None	True
volume_min	int	Filter by volume greater than this value.	None	True
volume_max	int	Filter by volume less than this value.	None	True
dividend_min	float	Filter by dividend amount greater than this value.	None	True
dividend_max	float	Filter by dividend amount less than this value.	None	True
is_etf	bool	If true, returns only ETFs.	False	True
is_active	bool	If false, returns only inactive tickers.	True	True
sector	Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']	Filter by sector.	None	True
industry	str	Filter by industry.	None	True
country	str	Filter by country, as a two-letter country code.	None	True
exchange	Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']	Filter by exchange.	None	True
limit	int	Limit the number of results to return.	50000	True

---

Data

• standard
• fmp

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the company.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the company.
market_cap	int	The market cap of ticker.
sector	str	The sector the ticker belongs to.
industry	str	The industry ticker belongs to.
beta	float	The beta of the ETF.
price	float	The current price.
last_annual_dividend	float	The last annual amount dividend paid.
volume	int	The current trading volume.
exchange	str	The exchange code the asset trades on.
exchange_name	str	The full name of the primary exchange.
country	str	The two-letter country abbreviation where the head office is located.
is_etf	Literal[True, False]	Whether the ticker is an ETF.
actively_trading	Literal[True, False]	Whether the ETF is actively trading.