Skip to main content

screener

Screener Overview.

Source Code: [link]

openbb.stocks.ca.screener(similar: List[str], data_type: str = "overview")

Parameters

NameTypeDescriptionDefaultOptional
similarList of similar companies.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().
NoneFalse
data_typestrData type between: overview, valuation, financial, ownership, performance, technicaloverviewTrue

Returns

TypeDescription
pd.DataFrameDataframe with overview, valuation, financial, ownership, performance or technical