Skip to contents

rb3 Package

rb3 rb3-package
Read files from Brazilian Financial Market

Download and Read Marketdata

read_marketdata()
Read and parses files delivered by B3
download_marketdata()
Download datasets
convert_to()
Converts B3 messy files to structured formats

Templates

show_templates()
Show templates.
display_template()
Display templates

Yield Curves

COTAHIST datasets

Indexes

index_get()
Get index historical data
indexes_get()
Get B3 indexes available
indexes_last_update()
Get the date of indexes composition last update
index_comp_get()
Get composition of B3 indexes
index_weights_get()
Get the assets weights of B3 indexes
index_by_segment_get()
Get B3 indexes available
indexreport_mget() indexreport_get()
Fetches indexes data from B3

Companies

company_cash_dividends_get()
Gets company's dividents in cash
company_info_get()
Gets information about the company
company_stock_dividends_get()
Gets company's stocks dividends
company_subscriptions_get()
Gets company's subscription rights

Futures

futures_mget() futures_get()
Get futures prices from trading session settlements page
maturity2date()
Get maturity date from maturity code
code2month()
Get month from maturity code

Super datasets (mix datasets)

yc_superset() yc_usd_superset() yc_ipca_superset()
Creates superset with yield curves and futures
cotahist_equity_options_superset() cotahist_options_by_symbol_superset()
Extracts equity option superset of data

Cache

cachedir()
Returns rb3 package cache directory
clearcache()
Clear cache directory