fmpc_security_dividends: Historical security dividend data

Description Usage Arguments Value Warning Examples

View source: R/securityMetrics.R

Description

Pulls dividends for a list of securities. Data includes dividend, adjusted dividend, payment date, record date, and declaration date

Usage

1
2
3
4
5
fmpc_security_dividends(
  symbols = "AAPL",
  startDate = Sys.Date() - 360,
  endDate = Sys.Date()
)

Arguments

symbols

one or more symbols from the FMP available list that can be found using fmpc_symbols_by_market. A valid API token must be set in order to enable functionality. See documentation for setting a token under fmpc_set_token.

startDate

filter start date in yyyy-mm-dd format.

endDate

filter end date in yyyy-mm-dd format.

Value

a data frame of dividend history that includes payment date, record date, and declaration date

Warning

Each symbol is a separate API call. If the API token has monthly limits, this should be considered before making a bulk request

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 

# Setting API key to DEMO allows for AAPL only
fmpc_set_token()
fmpc_security_dividends('AAPL')

# For multiple symbols, set a valid API Token
fmpc_set_token('FMPAPIKEY')
fmpc_security_dividends(c('AAPL','MSFT','SPY'), startDate = '2010-01-01')


## End(Not run)

fmpcloudr documentation built on Feb. 22, 2021, 5:05 p.m.