R: Stock Screener

fmpc_security_screener

R Documentation

Stock Screener

Description

Filter for stocks based on numerous criteria.

Usage

fmpc_security_screener(
  limit = 100,
  mrktCapAbove = NULL,
  mrktCapBelow = NULL,
  betaAbove = NULL,
  betaBelow = NULL,
  dividendAbove = NULL,
  dividendBelow = NULL,
  volumeAbove = NULL,
  volumeBelow = NULL,
  sector = NULL,
  industry = NULL
)

Arguments

`limit`	limit output to a certain amount or rows
`mrktCapAbove`	integer - market cap greater than
`mrktCapBelow`	integer - market cap less than
`betaAbove`	double - beta greater than
`betaBelow`	double - beta less than
`dividendAbove`	double - dividend greater than
`dividendBelow`	double - dividend less than
`volumeAbove`	integer - volume in shares greater than
`volumeBelow`	integer - volume in shares less than
`sector`	indicate a sector. Documentation is unclear of options. 'tech' is the example used
`industry`	indicate an industry. Documentation is unclear of options. 'Software' is the example used

Details

This function will temporarily modify options(scipen=999).

Value

a list of securities based on criteria supplied

Examples

## Not run: 

# Must set a valid API token
fmpc_set_token('FMPAPIKEY')
fmpc_security_screener() # Default pulls a list of 100 with no filters
# Search for market cap above a billion,
# that trades at least a million shares with a dividend under 1
fmpc_security_screener(mrktCapAbove = 1e9, dividendBelow = 1, volumeAbove = 1e6)


## End(Not run)