indexes_composition_get: Retrieve Composition of B3 Indexes

View source: R/scraper-indexes.R

indexes_composition_getR Documentation

Retrieve Composition of B3 Indexes

Description

This function fetches the composition of B3 indexes. It uses the template dataset "b3-indexes-composition" to retrieve the data.

Usage

indexes_composition_get()

Value

A data frame containing the columns:

update_date

The date when the data was last updated.

symbol

The symbol of the asset.

indexes

The indexes associated with the asset.

An arrow_dplyr_query or ArrowObject, representing a lazily evaluated query. The underlying data is not collected until explicitly requested, allowing efficient manipulation of large datasets without immediate memory usage. To trigger evaluation and return the results as an R tibble, use collect().

Examples

## Not run: 
  indexes_composition <- indexes_composition_get()
  head(indexes_composition)

## End(Not run)

rb3 documentation built on Aug. 8, 2025, 6:20 p.m.