from finalytics import Screener
screener = Screener(
quote_type="EQUITY",
filters=[
'{"operator": "eq", "operands": ["exchange", "NMS"]}'
],
sort_field="intradaymarketcap",
sort_descending=True,
offset=0,
size=100
)Screener Module Documentation
Screener
A class representing a Screener object for querying financial instruments.
__new__
Create a new Screener object.
Parameters:
quote_type(str): The type of financial instrument to screen. Options are:"EQUITY""MUTUALFUND""ETF""INDEX""FUTURE""CRYPTO"
filters(List[str]): A list of JSON strings specifying filter criteria. Each filter should follow the format:{ "operator": "<op>", "operands": ["<metric>", <value>[, <value2>]] }Where
<op>can be one of:"eq""gte""lte""gt""lt""btwn"
sort_field(str, optional): The metric to sort by.sort_descending(bool, default=True): Whether to sort in descending order.offset(int, default=0): The starting index of results to return.size(int, default=250): The maximum number of results to return.
Returns:
Screener: A Screener object.
Example:
Note: A full list of screener metrics for each category can be found at: https://github.com/Nnamdi-sys/finalytics/tree/main/rust/src/data/yahoo/screeners/screeners.json
symbols
Get the list of ticker symbols matching the screener criteria.
Returns:
List[str]: A list of ticker symbols, e.g.,["AAPL", "MSFT", "GOOGL"].
Example:
symbols = screener.symbols()
print(symbols)['NVDA', 'MSFT', 'AAPL', 'AMZN', 'GOOGL', 'GOOG', 'META', 'AVGO', 'TSLA', 'NFLX', 'COST', 'PLTR', 'ASML', 'CSCO', 'TMUS', 'AMD', 'LIN', 'INTU', 'AZN', 'TXN', 'PEP', 'BKNG', 'ISRG', 'QCOM', 'ARM', 'SHOP', 'ADBE', 'AMAT', 'AMGN', 'PDD', 'HON', 'GILD', 'CMCSA', 'LRCX', 'MU', 'KLAC', 'APP', 'ADP', 'MELI', 'SNY', 'ADI', 'CRWD', 'VRTX', 'COIN', 'SBUX', 'MSTR', 'INTC', 'DASH', 'CEG', 'CME', 'HOOD', 'MDLZ', 'TRI', 'SNPS', 'CTAS', 'NTES', 'CDNS', 'ABNB', 'FTNT', 'EQIX', 'MAR', 'PYPL', 'PANW', 'CSX', 'ADSK', 'MRVL', 'WDAY', 'REGN', 'ROP', 'NXPI', 'AEP', 'MNST', 'AXON', 'CHTR', 'JD', 'NDAQ', 'PAYX', 'TEAM', 'GSAT', 'DDOG', 'PCAR', 'KDP', 'CCEP', 'CPRT', 'ROST', 'ZS', 'EXC', 'IDXX', 'VRSK', 'KMB', 'ALNY', 'TCOM', 'XEL', 'FANG', 'TTWO', 'EA', 'MCHP', 'BKR', 'EBAY', 'FER']
overview
Get a Polars DataFrame containing the overview of screened instruments.
Returns:
DataFrame: A Polars DataFrame with overview data.
Example:
overview_df = screener.overview()
print(overview_df)shape: (100, 18)
┌─────────┬────────────┬────────────┬────────┬───┬────────────┬───────────┬────────────┬───────────┐
│ Symbol ┆ Name ┆ Exchange ┆ Region ┆ … ┆ EPS ┆ Price/EPS ┆ Price/Book ┆ Analyst │
│ --- ┆ --- ┆ --- ┆ --- ┆ ┆ (Current ┆ --- ┆ --- ┆ Rating │
│ str ┆ str ┆ str ┆ str ┆ ┆ Year) ┆ f64 ┆ f64 ┆ --- │
│ ┆ ┆ ┆ ┆ ┆ --- ┆ ┆ ┆ str │
│ ┆ ┆ ┆ ┆ ┆ f64 ┆ ┆ ┆ │
╞═════════╪════════════╪════════════╪════════╪═══╪════════════╪═══════════╪════════════╪═══════════╡
│ "NVDA" ┆ "NVIDIA ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 4.28706 ┆ 40.25605 ┆ 50.19782 ┆ "1.5 - │
│ ┆ Corporatio ┆ ┆ ┆ ┆ ┆ ┆ ┆ Strong │
│ ┆ n" ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ "MSFT" ┆ "Microsoft ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 13.40369 ┆ 38.088367 ┆ 11.790409 ┆ "1.4 - │
│ ┆ Corporatio ┆ ┆ ┆ ┆ ┆ ┆ ┆ Strong │
│ ┆ n" ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ "AAPL" ┆ "Apple ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 7.18592 ┆ 29.699747 ┆ 47.734283 ┆ "2.1 - │
│ ┆ Inc." ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ "AMZN" ┆ "Amazon.co ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 6.21447 ┆ 36.830975 ┆ 7.9418807 ┆ "1.4 - │
│ ┆ m, Inc." ┆ ┆ ┆ ┆ ┆ ┆ ┆ Strong │
│ ┆ ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ "GOOGL" ┆ "Alphabet ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 9.6009 ┆ 19.719704 ┆ 6.6652665 ┆ "1.6 - │
│ ┆ Inc." ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … │
│ "EA" ┆ "Electroni ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 8.2262 ┆ 18.573582 ┆ 6.036744 ┆ "2.2 - │
│ ┆ c Arts ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ ┆ Inc." ┆ ┆ ┆ ┆ ┆ ┆ ┆ │
│ "MCHP" ┆ "Microchip ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 1.40134 ┆ 53.15626 ┆ 5.669381 ┆ "1.8 - │
│ ┆ Technology ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ ┆ Incorpor… ┆ ┆ ┆ ┆ ┆ ┆ ┆ │
│ "BKR" ┆ "Baker ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 2.37961 ┆ 16.824184 ┆ 2.326534 ┆ "1.7 - │
│ ┆ Hughes ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
│ ┆ Company" ┆ ┆ ┆ ┆ ┆ ┆ ┆ │
│ "EBAY" ┆ "eBay ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 5.34014 ┆ 14.819837 ┆ 7.402488 ┆ "2.8 - │
│ ┆ Inc." ┆ ┆ ┆ ┆ ┆ ┆ ┆ Hold" │
│ "FER" ┆ "Ferrovial ┆ "NasdaqGS" ┆ "US" ┆ … ┆ 0.75289 ┆ 70.22274 ┆ 6.282081 ┆ "1.0 - │
│ ┆ SE" ┆ ┆ ┆ ┆ ┆ ┆ ┆ Strong │
│ ┆ ┆ ┆ ┆ ┆ ┆ ┆ ┆ Buy" │
└─────────┴────────────┴────────────┴────────┴───┴────────────┴───────────┴────────────┴───────────┘
metrics
Get a Polars DataFrame containing detailed metrics for screened instruments.
Returns:
DataFrame: A Polars DataFrame with detailed metrics.
Example:
metrics_df = screener.metrics()
print(metrics_df)shape: (100, 51)
┌────────┬──────────┬────────────┬────────────┬───┬────────────┬───────────┬───────────┬───────────┐
│ Symbol ┆ Currency ┆ Current ┆ Day Range ┆ … ┆ Analyst ┆ Average ┆ High/Low ┆ Analyst │
│ --- ┆ --- ┆ Price ┆ --- ┆ ┆ Consensus ┆ Target ┆ Target ┆ Count │
│ str ┆ str ┆ --- ┆ str ┆ ┆ --- ┆ --- ┆ --- ┆ --- │
│ ┆ ┆ str ┆ ┆ ┆ str ┆ str ┆ str ┆ str │
╞════════╪══════════╪════════════╪════════════╪═══╪════════════╪═══════════╪═══════════╪═══════════╡
│ NVDA ┆ USD ┆ 172.58 ┆ 173.38 - ┆ … ┆ strong_buy ┆ Median: ┆ 250.00 - ┆ 57 │
│ ┆ ┆ ┆ 171.45 ┆ ┆ ┆ 175.00, ┆ 100.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 173.92 ┆ ┆ │
│ MSFT ┆ USD ┆ 510.52 ┆ 512.07 - ┆ … ┆ strong_buy ┆ Median: ┆ 700.00 - ┆ 50 │
│ ┆ ┆ ┆ 505.59 ┆ ┆ ┆ 510.82, ┆ 432.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 522.26 ┆ ┆ │
│ AAPL ┆ USD ┆ 213.41 ┆ 215.78 - ┆ … ┆ buy ┆ Median: ┆ 300.00 - ┆ 40 │
│ ┆ ┆ ┆ 211.64 ┆ ┆ ┆ 230.00, ┆ 170.62 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 228.60 ┆ ┆ │
│ AMZN ┆ USD ┆ 228.87 ┆ 229.08 - ┆ … ┆ strong_buy ┆ Median: ┆ 305.00 - ┆ 65 │
│ ┆ ┆ ┆ 225.65 ┆ ┆ ┆ 240.00, ┆ 195.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 241.82 ┆ ┆ │
│ GOOGL ┆ USD ┆ 189.32 ┆ 189.85 - ┆ … ┆ buy ┆ Median: ┆ 250.00 - ┆ 53 │
│ ┆ ┆ ┆ 186.15 ┆ ┆ ┆ 200.00, ┆ 160.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 201.47 ┆ ┆ │
│ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … ┆ … │
│ EA ┆ USD ┆ 152.79 ┆ 153.13 - ┆ … ┆ buy ┆ Median: ┆ 210.00 - ┆ 25 │
│ ┆ ┆ ┆ 149.79 ┆ ┆ ┆ 166.00, ┆ 127.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 167.20 ┆ ┆ │
│ MCHP ┆ USD ┆ 74.47 ┆ 76.09 - ┆ … ┆ buy ┆ Median: ┆ 85.00 - ┆ 23 │
│ ┆ ┆ ┆ 74.16 ┆ ┆ ┆ 66.21, ┆ 50.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 66.66 ┆ ┆ │
│ BKR ┆ USD ┆ 40.03 ┆ 40.21 - ┆ … ┆ buy ┆ Median: ┆ 56.00 - ┆ 26 │
│ ┆ ┆ ┆ 39.52 ┆ ┆ ┆ 46.00, ┆ 39.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 46.44 ┆ ┆ │
│ EBAY ┆ USD ┆ 79.12 ┆ 79.22 - ┆ … ┆ hold ┆ Median: ┆ 79.00 - ┆ 28 │
│ ┆ ┆ ┆ 78.29 ┆ ┆ ┆ 69.50, ┆ 50.00 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 67.34 ┆ ┆ │
│ FER ┆ USD ┆ 52.87 ┆ 53.28 - ┆ … ┆ strong_buy ┆ Median: ┆ 58.40 - ┆ 2 │
│ ┆ ┆ ┆ 52.68 ┆ ┆ ┆ 54.42, ┆ 50.45 ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ Mean: ┆ ┆ │
│ ┆ ┆ ┆ ┆ ┆ ┆ 54.42 ┆ ┆ │
└────────┴──────────┴────────────┴────────────┴───┴────────────┴───────────┴───────────┴───────────┘
display
Display the overview and metrics DataFrames as interactive DataTables in the web browser.
Example:
screener.display()