company_stock_dividends_get: Gets company's stocks dividends

In rb3: Download and Parse Public Data Released by B3 Exchange

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)

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.

Value

data.frame with all stocks dividends

Examples

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

## End(Not run)

rb3 documentation built on April 14, 2023, 5:10 p.m.