screener
Screen US-listed equities by exchange, sector, region, and market cap.
Examples
from openbb import obb
# Screen the full Nasdaq-listed universe.
obb.nasdaq.equity.screener(exchange='nasdaq', provider='nasdaq')
Parameters
- standard
- nasdaq
exchange: str | None | list[str | None]
Default: all
Filter by exchange. Multiple items allowed.
Choices
- all
- nasdaq
- nyse
- amex
exsubcategory: str | None | list[str | None]
Default: all
Description
Filter by exchange subcategory.
- NGS - Nasdaq Global Select Market
- NGM - Nasdaq Global Market
- NCM - Nasdaq Capital Market
- ADR - American Depository Receipt Multiple items allowed.
Choices
- all
- ngs
- ngm
- ncm
- adr
mktcap: str | None | list[str | None]
Default: all
Description
Filter by market cap.
- Mega - > 200B
- Large - 10B - 200B
- Mid - 2B - 10B
- Small - 300M - 2B
- Micro - 50M - 300M Multiple items allowed.
Choices
- all
- mega
- large
- mid
- small
- micro
recommendation: str | None | list[str | None]
Default: all
Filter by consensus analyst action. Multiple items allowed.
Choices
- all
- strong_buy
- buy
- hold
- sell
- strong_sell
sector: str | None | list[str | None]
Default: all
Filter by sector. Multiple items allowed.
Choices
- all
- energy
- basic_materials
- industrials
- consumer_staples
- consumer_discretionary
- health_care
- financial_services
- technology
- communication_services
- utilities
- real_estate
region: str | None | list[str | None]
Default: all
Filter by region. Multiple items allowed.
Choices
- all
- africa
- asia
- australia_and_south_pacific
- caribbean
- europe
- middle_east
- north_america
- south_america
country: str | None | list[str | None]
Default: all
Filter by country. Accepts country names, ISO 3166-1 alpha-2/alpha-3 codes, or 'all' for all countries. Multiple comma-separated values allowed. Multiple items allowed.
Choices
- all
- argentina
- armenia
- australia
- austria
- belgium
- bermuda
- brazil
- canada
- cayman_islands
- chile
- colombia
- costa_rica
- curacao
- cyprus
- denmark
- finland
- france
- germany
- greece
- guernsey
- hong_kong
- india
- indonesia
- ireland
- isle_of_man
- israel
- italy
- japan
- jersey
- luxembourg
- macau
- mexico
- monaco
- netherlands
- norway
- panama
- peru
- philippines
- puerto_rico
- russia
- singapore
- south_africa
- south_korea
- spain
- sweden
- switzerland
- taiwan
- turkey
- united_kingdom
- united_states
- usa
limit: int | None
Limit the number of results to return.
Returns
results: NasdaqEquityScreener
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- nasdaq
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the company.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the company.
last_price: float
Last sale price.
change: float | None
1-day change in price.
change_percent: float | None
1-day percent change in price.
market_cap: float | None
Market cap.
volume: float | None
The last session's share volume.
country: str | None
The country the company is domiciled in.
ipo_year: int | None
The year the company listed.
industry: str | None
The industry of the company.
sector: str | None
The sector of the company.