Author: Marcelo Perlin
Date: 2022-06-13

# Using GetFREData

#### Marcelo Perlin

#### 2022-06-13

# Package GetFREData

`GetFREData` is an R package for downloading information about companies traded at B3, the Brazilian financial exchange. The source of the data is B3’s FRE, the official system for the registration of all major corporate actions.

The corporate data includes (since 2010):

- List of stockholders
- All capital issues
- Stock value over years
- Compensation of boards and directors
- Composition of boards and comittes
- Family relations within the company
- List of companies related to family members
- Stock details
- Intangible details
- Auditing details
- Dividends details

## Installation

    # CRAN (stable)
    install.packages('GetFREData')

    # github (development)
    if (!require(devtools)) install.packages('devtools')
    if (!require(GetFREData)) devtools::install_github('msperlin/GetFREData')

## Example of usage

    library(GetFREData)
    library(tidyverse)

    search_company('grendene',
                   cache_folder = tempdir())

    l_fre <- get_fre_data(companies_cvm_codes = 19615,
                          fre_to_read = 'last',
                          first_year = 2020,
                          last_year = 2020,
                          cache_folder = tempdir())

    glimpse(l_fre)