Screener¶

Getting screener information.

Overview¶

class finvizfinance.screener.overview.Overview¶

Getting information from the finviz screener overview page.

compare(ticker, compare_list, order='ticker', verbose=1)¶

Get screener table of similar property (Sector, Industry, Country)

Parameters:	ticker (str) – the ticker to compare compare_list (list) – choice of compare property (Sector, Industry, Country) or combination. order (str) – sort the table by the choice of order verbose (int) – choice of visual the progress. 1 for visualize progress
Returns:	screener information table
Return type:	df(pandas.DataFrame)

get_filter_options(screen_filter)¶

Get filters options.

Parameters:	screen_filter (str) – screen filter for checking options
Returns:	all the available filters
Return type:	filter_options(list)

get_filters()¶

Get filters.

Returns:	all the available filters
Return type:	filters(list)

get_orders()¶

Get orders.

Returns:	all the available orders
Return type:	orders(list)

get_signal()¶

Get signals.

Returns:	all the available trading signals
Return type:	signals(list)

screener_view(order='ticker', limit=-1, select_page=None, verbose=1, ascend=True, sleep_sec=1)¶

Get screener table.

Parameters:	order (str) – sort the table by the choice of order. limit (int) – set the top k rows of the screener. select_page (int) – set the page of the screener. verbose (int) – choice of visual the progress. 1 for visualize progress. ascend (bool) – if True, the order is ascending. sleep_sec (int) – sleep seconds for fetching each page.
Returns:	screener information table
Return type:	df(pandas.DataFrame)

set_filter(signal='', filters_dict={}, ticker='')¶

Update the settings.

Parameters:	signal (str) – ticker signal filters_dict (dict) – dictionary of filters ticker (str) – ticker string

class finvizfinance.screener.valuation.Valuation¶: Valuation inherit from overview module. Getting information from the finviz screener valuation page.

class finvizfinance.screener.financial.Financial¶: Financial inherit from overview module. Getting information from the finviz screener financial page.

class finvizfinance.screener.ownership.Ownership¶: Ownership inherit from overview module. Getting information from the finviz screener ownership page.

class finvizfinance.screener.technical.Technical¶: Technical inherit from overview module. Getting information from the finviz screener technical page.

class finvizfinance.screener.custom.Custom¶

Custom inherit from overview module. Getting information from the finviz screener custom page.

get_columns()¶

Get information about the columns

Returns:	return the index and column name.
Return type:	columns(dict)

screener_view(order='ticker', limit=-1, select_page=None, verbose=1, ascend=True, columns=[0, 1, 2, 3, 4, 5, 6, 7, 65, 66, 67], sleep_sec=1)¶

Get screener table.

Parameters:	order (str) – sort the table by the choice of order. limit (int) – set the top k rows of the screener. select_page (int) – set the page of the screener. verbose (int) – choice of visual the progress. 1 for visualize progress. ascend (bool) – if True, the order is ascending. columns (list) – columns of your choice. Default index: 0,1,2,3,4,5,6,7,65,66,67. sleep_sec (int) – sleep seconds for fetching each page.
Returns:	screener information table
Return type:	df(pandas.DataFrame)

class finvizfinance.screener.ticker.Ticker¶

Financial inherit from overview module. Getting information from the finviz screener ticker page.

screener_view(order='ticker', limit=-1, verbose=1, ascend=True, sleep_sec=1)¶

Get screener stocks.

Parameters:	order (str) – sort the list by the choice of order. limit (int) – set the top k stocks of the screener. verbose (int) – choice of visual the progress. 1 for visualize progress. ascend (bool) – if True, the order is ascending. sleep_sec (int) – sleep seconds for fetching each page.
Returns:	get all the tickers as list.
Return type:	tickers(list)