fmpc_security_splits: Historical security split data

In exploringfinance/fmpcloudr: R Access to the 'FMP Cloud' and 'Financial Modeling Prep' API

Historical security split data

Description

Pulls stock split history for one or more securities

Usage

fmpc_security_splits(
  symbols = "AAPL",
  startDate = Sys.Date() - 3600,
  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 split history

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

## Not run: 

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

# For multiple symbols, set a valid API Token
fmpc_set_token('FMPAPIKEY')
fmpc_security_splits(c('AAPL','TSLA'), startDate = '2020-01-01')


## End(Not run)

exploringfinance/fmpcloudr documentation built on Feb. 5, 2024, 11:02 a.m.