Screener

Getting screener information.

Overview

class finvizfinance.screener.overview.Overview

Bases: Base

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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Valuation

class finvizfinance.screener.valuation.Valuation

Bases: Base

Getting information from the finviz screener valuation 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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Financial

class finvizfinance.screener.financial.Financial

Bases: Base

Getting information from the finviz screener financial 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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Ownership

class finvizfinance.screener.ownership.Ownership

Bases: Base

Getting information from the finviz screener ownership 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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Performance

class finvizfinance.screener.performance.Performance

Bases: Base

Getting information from the finviz screener performance 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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Technical

class finvizfinance.screener.technical.Technical

Bases: Base

Getting information from the finviz screener technical 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)

screener_view(order='Ticker', limit=100000, select_page=None, verbose=1, ascend=True, columns=None, 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

Ticker

class finvizfinance.screener.ticker.Ticker

Bases: Base

Financial Getting information from the finviz screener ticker 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)

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)

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

Update the settings.

Parameters:

• signal (str) – ticker signal

• filters_dict (dict) – dictionary of filters

• ticker (str) – ticker string