company_cash_dividends_get {rb3}

Gets company's dividents in cash

Description

Gets a list of all dividents in cash paid by the company. A cash dividend is a payment made by a company out of its earnings to investors in the form of cash. (https://www.investopedia.com/)

Usage

company_cash_dividends_get(code, cache_folder = cachedir(), do_cache = TRUE)

Arguments

code

Represents the company, can be the stock symbol, like PETR4 or the first four characters PETR

cache_folder

Location of cache folder (default = cachedir())

do_cache

Whether to use cache or not (default = TRUE)

Details

The code parameter can be the stock symbol, but the returned data refers to the company, always. The returned data.frame has all company's symbols that paid dividends in cash.

Value

data.frame with company information

Examples

## Not run: 
company_cash_dividends_get(c("PETR", "VALE", "MGLU"))

## End(Not run)