rb3 (version 0.0.12)

company_stock_dividends_get: Gets company's stocks dividends

Description

Gets a list of all stocks dividends paid by the company. A stock dividend is a payment to shareholders that consists of additional shares rather than cash. (https://www.investopedia.com/)

Usage

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

Value

data.frame with all stocks dividends

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 stocks.

Examples

if (FALSE) {
company_stock_dividends_get(c("PETR", "VALE", "MGLU"))
}