get_dividends: Get Security Historical Dividends

In chrishaarstick/madstork: MadStork Portfolio Management

Description

Wrapper function around quantmod::getDividend function

Usage

get_dividends(symbols, start_date = "1990-01-01",
  end_date = Sys.Date())

Arguments

symbols	vector of stock symbol characters. can be 1 or more
start_date	starting date for historical dividends. default is '1990-01-01'. Y-m-d format required
end_date	ending date for historical dividends. default is current date. Y-m-d format required

Value

tibble with a record for each dividend distrubtion per security

Examples

library(tidyverse)
symbols <- c("spy", "tlt")
dividends <- symbols %>% get_dividends(., start_date = "2016-01-01")

chrishaarstick/madstork documentation built on Jan. 3, 2022, 8:34 p.m.