company_subscriptions_get: Gets company's subscription rights

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

Gets company's subscription rights

Description

Gets a list of all company's subscription rights. A subscription right is the right of existing shareholders in a company to retain an equal percentage ownership by subscribing to new stock issuances at or below market prices. (https://www.investopedia.com/)

Usage

company_subscriptions_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 have issued subscription rights.

Value

data.frame with company information

Examples

## Not run: 
company_subscriptions_get(c("PDGR", "VALE", "MGLU"))

## End(Not run)

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