getDividends: Download dividends data

getDividendsR Documentation

Download dividends data

Description

This function returns dividends data from Investing.com or Tinkoff broker.

Usage

getDividends(
  src = "investing",
  figi = "",
  api.key = "",
  from = Sys.Date() - 10,
  to = Sys.Date(),
  country = ""
)

Arguments

src

source of dividends information. Could be 'investing' or 'tinkoff'

figi

FIGI of the instrument to get dividends for (only for Tinkoff broker)

api.key

Tinkoff broker API key (only for Tinkoff broker)

from

start date of the dividends data. Default is 10 days ago

to

end date of the dividends data. Default is today

country

a character string with the country name to filter dividends data for (only for Investing.com)

Value

a list with dividends data

Note

Not for the faint of heart. All profits and losses related are yours and yours alone. If you don't like it, write it yourself.

Author(s)

Vyacheslav Arbuzov

Examples

getDividends(from = Sys.Date(),to = Sys.Date()+2,country = "Australia")

arbuzovv/rusquant documentation built on Feb. 1, 2024, 6:39 p.m.