getDividendsCalendar: Get dividends calendar from earnings.com

In qmao: Quantmod Add-on

Description

Get information about dividends of stocks that go (went) ex-dividend on a given Date or range of dates.

Usage

  .getDividendsCalendar(Date = Sys.Date())

  getDividendsCalendar(from, to)

Arguments

Date	a Date, or character string in the format CCYY-MM-DD
from	first Date for which to retrieve the Dividend Calendar
to	last Date for which to retrieve the Dividend Calendar

Details

.getDividendsCalendar will usually be called by getCalendarByDay, but it can also be called directly.

getDividendsCalendar is a wrapper that creates a sequence of dates between from and to, and then applies .getDividendsCalendar to each of those dates and, finally, merges the results together into a single data.frame.

Value

a data.frame with columns “SYMBOL”, “COMPANY”, “AMOUNT”, “EX-DATE”, “PAYABLE”, “RECORD”, and “DECLARATION”

Note

ALPHA CODE!!! Subject to change.

Author(s)

Garrett See

References

http://www.earnings.com/dividend.asp?date=&client=cb

See Also

getEconomicCalendar, getEarningsCalendar, getCalendarByDay

Examples

## Not run: 
## fetch the Dividends Calendar from yahoo for today
.getDividendsCalendar()
## fetch the Dividends Calendar for a range of dates
getDividendsCalendar(from=Sys.Date(), to=Sys.Date() + 7)

## End(Not run)

qmao documentation built on May 2, 2019, 4:54 p.m.