screener
Screen for companies meeting various criteria.
These criteria include market cap, price, beta, volume, and dividend yield.
Examples
from openbb import obb
obb.equity.screener(provider='fmp')
Parameters
- standard
- finviz
- fmp
- nasdaq
- yfinance
metric
: Literal['overview', 'valuation', 'financial', 'ownership', 'performance', 'technical']
The data group to return, default is 'overview'.
• Default: overview
• Optional: True
exchange
: Literal['all', 'amex', 'nasdaq', 'nyse']
Filter by exchange.
• Default: all
• Optional: True
index
: Literal['all', 'dow', 'nasdaq', 'sp500', 'russell']
Filter by index.
• Default: all
• Optional: True
sector
: Literal['all', 'energy', 'materials', 'industrials', 'consumer_cyclical', 'consumer_defensive', 'financial', 'healthcare', 'technology', 'communication_services', 'utilities', 'real_estate']
Filter by sector.
• Default: all
• Optional: True
industry
: str
Filter by industry.
Choices
all
stocks_only
etf
advertising_agencies
aerospace_defense
agricultural_inputs
airlines
airports_airservices
aluminum
apparel_manufacturing
apparel_retail
asset_management
auto_manufacturers
auto_parts
auto_dealerships
banks_diversified
banks_regional
beverages_brewers
beverages_nonalcoholic
beverages_wineries_distilleries
biotechnology
broadcasting
building_materials
building_products_equipment
business_equipment_supplies
capital_markets
chemicals
closed_end_fund_debt
closed_end_fund_equity
closed_end_fund_foreign
coking_coal
communication_equipment
computer_hardware
confectioners
conglomerates
consulting_services
consumer_electronics
copper
credit_services
department_stores
diagnostics_research
discount_stores
drug_manufacturers_general
drug_manufacturers_specialty_generic
education_training_services
electrical_equipment_parts
electronic_components
electronic_gaming_multimedia
electronics_computer_distribution
engineering_construction
entertainment
farm_heavy_construction_machinery
farm_products
financial_conglomerates
financial_data_stock_exchanges
food_distribution
footwear_accessories
furnishings_fixtures_appliances
gambling
gold
grocery_stores
health_care_plans
health_information_services
home_improvement_retail
household_personal_products
industrial_distribution
information_technology_services
infrastructure_operations
insurance_brokers
insurance_diversified
insurance_life
insurance_property_casualty
insurance_reinsurance
insurance_specialty
integrated_freight_logistics
internet_content_information
internet_retail
leisure
lodging
lumber_wood_production
luxury_goods
marine_shipping
medical_care_facilities
medical_devices
medical_distribution
medical_instruments_supplies
metal_fabrication
mortgage_finance
oil_gas_drilling
oil_gas_ep
oil_gas_equipment_services
oil_gas_integrated
oil_gas_midstream
oil_gas_refining_marketing
other_industrial_metals_mining
other_precious_metals_mining
packaged_foods
packaging_containers
paper_paper_products
personal_services
pharmaceutical_retailers
pollution_treatment_controls
publishing
railroads
real_estate_development
real_estate_diversified
real_estate_services
recreational_vehicles
reit_diversified
reit_health_care_facilities
reit_hotel_motel
reit_industrial
reit_mortgage
reit_office
reit_residential
reit_retail
reit_specialty
rental_leasing_services
residential_construction
resorts_casinos
restaurants
scientific_technical_instruments
security_protection_services
semiconductor_equipment_materials
semiconductors
shell_companies
silver
software_application
software_infrastructure
solar
specialty_business_services
specialty_chemicals
specialty_industrial_machinery
specialty_retail
staffing_employment_services
steel
telecom_services
textile_manufacturing
thermal_coal
tobacco
tools_accessories
travel_services
trucking
uranium
utilities_diversified
utilities_independent_power_producers
utilities_regulated_electric
utilities_regulated_gas
utilities_regulated_water
utilities_renewable
waste_management
• Default: all
• Optional: True
mktcap
: Literal['all', 'mega', 'large', 'large_over', 'large_under', 'mid', 'mid_over', 'mid_under', 'small', 'small_over', 'small_under', 'micro', 'micro_over', 'micro_under', 'nano']
Description
Filter by market cap.
Mega - > 200B
Large - 10B - 200B
Mid - 2B - 10B
Small - 300M - 2B
Micro - 50M - 300M
Nano - < 50M
• Default: all
• Optional: True
recommendation
: Literal['all', 'strong_buy', 'buy+', 'buy', 'hold+', 'hold', 'hold-', 'sell', 'sell-', 'strong_sell']
Filter by analyst recommendation.
• Default: all
• Optional: True
signal
: str
Description
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 (contiunation)
wedge_down: downward trendline support and downward trendline resistance (reversal)
wedge_up: upward trendline support and upward trendline resistance (reversal)
Choices
channel
channel_down
channel_up
double_bottom
double_top
downgrades
earnings_after
earnings_before
head_shoulders
head_shoulders_inverse
horizontal_sr
major_news
most_active
most_volatile
multiple_bottom
multiple_top
new_high
new_low
overbought
oversold
recent_insider_buying
recent_insider_selling
tl_resistance
tl_support
top_gainers
top_losers
triangle_ascending
triangle_descending
unusual_volume
upgrades
wedge
wedge_down
wedge_up
• Optional: True
preset
: str
Description
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)
• Optional: True
filters_dict
: Union[Dict, str]
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.
• Optional: True
limit
: int
The number of data entries to return.
• Optional: True
mktcap_min
: int
Filter by market cap greater than this value.
• Optional: True
mktcap_max
: int
Filter by market cap less than this value.
• Optional: True
price_min
: float
Filter by price greater than this value.
• Optional: True
price_max
: float
Filter by price less than this value.
• Optional: True
beta_min
: float
Filter by a beta greater than this value.
• Optional: True
beta_max
: float
Filter by a beta less than this value.
• Optional: True
volume_min
: int
Filter by volume greater than this value.
• Optional: True
volume_max
: int
Filter by volume less than this value.
• Optional: True
dividend_min
: float
Filter by dividend amount greater than this value.
• Optional: True
dividend_max
: float
Filter by dividend amount less than this value.
• Optional: True
is_etf
: bool
If true, returns only ETFs.
• Default: False
• Optional: True
is_active
: bool
If false, returns only inactive tickers.
• Default: True
• Optional: True
sector
: Literal['consumer_cyclical', 'energy', 'technology', 'industrials', 'financial_services', 'basic_materials', 'communication_services', 'consumer_defensive', 'healthcare', 'real_estate', 'utilities', 'industrial_goods', 'financial', 'services']
Filter by sector.