Skip to main content

screener

Screen for companies meeting various criteria.

These criteria include market cap, price, beta, volume, and dividend yield.

Parameters


Returns

results: list[EquityScreener]

Serializable results.


provider: Optional[Literal['finviz', 'fmp', 'nasdaq', 'yfinance']]

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data

symbol: str

Symbol representing the entity requested in the data.

name: str

Name of the company.