fmp_screen_stocks: Company Stock Screener

In jpiburn/fmpapi: Access to the Financial Modeling Prep Financial Data API

Description

Company Stock Screener

Usage

fmp_screen_stocks(
  marketCapMoreThan = NULL,
  marketCapLowerThan = NULL,
  betaMoreThan = NULL,
  betaLowerThan = NULL,
  volumeMoreThan = NULL,
  volumeLowerThan = NULL,
  dividendMoreThan = NULL,
  dividendLowerThan = NULL,
  sector = NULL,
  exchange = NULL,
  limit = NULL
)

Arguments

marketCapMoreThan	numeric. Default is NULL
marketCapLowerThan	numeric. Default is NULL
betaMoreThan	numeric. Default is NULL
betaLowerThan	numeric. Default is NULL
volumeMoreThan	numeric. Default is NULL
volumeLowerThan	numeric. Default is NULL
dividendMoreThan	numeric. Default is NULL
dividendLowerThan	numeric. Default is NULL
sector	character. See Details for avialable values
exchange	character. See Details for avialable values
limit	numeric. Default is NULL

Details

sector paramater can be anyone of the following:

• "Consumer Cyclical"

• "Energy"

• "Technology"

• "Industrials"

• "Financial Services"

• "Basic Materials"

• "Communication Services"

• "Consumer Defensive"

• "Healthcare"

• "Real Estate"

• "Utilities"

• "Industrial Goods"

• "Financial"

• "Services"

• "Conglomerates"

exchange paramater can be anyone of the following:

• "nyse"

• "nasdaq"

• "amex"

• "euronext"

• "tsx"

• "etf"

• "mutual_fund"

Value

a tibble of stocks matching criteria

Examples

library(fmpapi)

# small cap, high beta tech stocks
d <- fmp_screen_stocks(marketCapLowerThan = 1e9, betaMoreThan = 2, sector = 'Technology')

# mid cap healthcare stocks listed on the nasdaq
d <- fmp_screen_stocks(marketCapMoreThan = 1e9, marketCapLowerThan = 1e10,
sector = 'Healthcare', exchange = 'nasdaq')

jpiburn/fmpapi documentation built on Aug. 20, 2021, 12:51 a.m.