Skip to contents

List the CVM CKAN groups

Source: R/api-cvm-groups.R
cvm_groups.Rd

Returns the 18 thematic groups published by the CVM Open Data Portal (<https://dados.cvm.gov.br/group/>), each with the number of datasets the portal exposes for it and the canonical cvmdata fetcher contract that covers it.

Usage

cvm_groups()

Value

A tibble with 18 rows, sorted alphabetically by group. Columns:

  • group (character) – the CKAN slug (e.g. "companhias", "fundos-de-investimento").

  • n_datasets (integer) – count of datasets the CVM portal publishes under this group.

  • contract (character) – one of "issuer", "fund", "agent", "offering", "event". Identifies the cvmdata fetcher that covers (or will cover) the group.

Details

v0.1.0.9000 implements only the companhias group (via issuer_fetch()); the remaining 17 rows document the planned v0.2-v0.8 coverage so users can navigate the universe of CVM data before the corresponding fetchers ship. Calls to the four non-issuer fetchers in v0.1.0.9000 abort with cvmdata_error_input_group; see fund_fetch(), agent_fetch(), offering_fetch() and event_fetch().

The n_datasets column reports the totals published by CVM, not the count currently implemented in the package. The mapping between groups and contracts is fixed for the lifetime of v0.1.x; see data-raw/decisions/cvmdata_arquitetura_grupos_decisao_v2.md for the rationale.

See also

cvm_datasets(), issuer_fetch()

Other discovery: cvm_codelist(), cvm_dataset_years(), cvm_datasets(), cvm_dictionary(), cvm_tables()

Examples

cvm_groups()
#> # A tibble: 18 × 3
#>    group                               n_datasets contract
#>    <chr>                                    <int> <chr>   
#>  1 administradores                              2 agent   
#>  2 agentes-autonomos                            1 agent   
#>  3 agentes-fiduciarios                          1 agent   
#>  4 atividade-sancionadora                       1 event   
#>  5 atos-declaratorios                           1 event   
#>  6 auditores                                    1 agent   
#>  7 companhias                                  12 issuer  
#>  8 consultores-de-valores-mobiliarios           1 agent   
#>  9 coordenadores-de-ofertas                     1 agent   
#> 10 emissores-de-cepac                           1 issuer  
#> 11 fundos-de-investimento                      22 fund    
#> 12 fundos-de-investimento-imobiliarios          4 fund    
#> 13 fundos-estruturados                         10 fund    
#> 14 investidores-nao-residentes                  1 agent   
#> 15 ofertas-publicas                             2 offering
#> 16 participantes-intermediarios                 1 agent   
#> 17 plataformas-de-crowdfunding                  1 offering
#> 18 securitizadoras                              4 issuer  

# All groups served by issuer_fetch()
g <- cvm_groups()
g[g$contract == "issuer", ]
#> # A tibble: 3 × 3
#>   group              n_datasets contract
#>   <chr>                   <int> <chr>   
#> 1 companhias                 12 issuer  
#> 2 emissores-de-cepac          1 issuer  
#> 3 securitizadoras             4 issuer