yfinance.Screener

class yfinance.Screener(session=None, proxy=None)

The Screener class is used to execute the queries and return the filtered results.

The Screener class provides methods to set and manipulate the body of a screener request, fetch and parse the screener results, and access predefined screener bodies.

Parameters:

• session (requests.Session, optional) – A requests session object to be used for making HTTP requests. Defaults to None.

• proxy (str, optional) – A proxy URL to be used for making HTTP requests. Defaults to None.

See also

Screener.predefined_bodies

supported predefined screens

Attributes

body
predefined_bodies	Predefined Screeners
response	Fetch screen result

Methods

__init__([session, proxy])
patch_body(values)	Patch parts of the body
set_body(body)	Set the fully custom body
set_default_body(query[, offset, size, ...])	Set the default body using a custom query
set_predefined_body(k)	Set a predefined body