get_dair_carteira: Extrai dados da carteira de investimentos da API do CADPREV

In marcosfs2006/ADPrev: Análise de Dados Previdenciários dos RPPS

Description

Função para a obtenção de dados relativos às carteiras de investimentos dos RPPS a partir da API do CADPREV cuja documentação pode ser consultada em https://apicadprev.economia.gov.br/api-docs/.

Usage

get_dair_carteira(...)

Arguments

...	Qualquer um dos parâmetros de consulta disponibilizados pela API para a consulta ao DAIR - Carteira.

Details

Embora a função aceite como parâmetros qualquer um dos que possam ser passados ao ponto de acesso DAIR_CARTEIRA recomendamos utilizar os parâmtros abaixo elencados e depois realizar os filtros desejados.

• nr_cnpj_entidade caractere indicando o CNPJ do Ente a que pertence o RPPS

• no_ente caractere indicando o nome do Ente a que pertence o RPPS

• sg_uf caractere indicando a sigla da unidade da federação a que pertence o RPPS

• dt_ano inteiro indicando o ano da posição da carteira

• dt_mes_bimestre inteiro indicando o mês (ou bimestre) da posição da carteira

A sigla da UF deve ser fornecida em letras maiúsculas.

O nome do Ente deve ser fornecido exatamente como consta da base de dados.

Para evitar erros devidos a incorreções no nome do Ente recomenda-se utilizar o CNPJ do Ente para consultas relativas a um RPPS específico.

Até 20216 a posição das carteiras de investimento dos RPPS era apresentada ao término de cada bimestre. A partir de 2017 a posição da carteira passou a ser disponibilizada mensalmente, isto é, ao término de cada mês.

Value

Um data frame contendo os dados requisitados.

Examples

## Not run:  
# Obtém os dados da carteira de investimento dos RPPS do RJ para
# todos os mesess do ano de 2021

dair_RJ2021 <- get_dair_carteira(sg_uf="RJ", dt_ano=2021) 

# Obtém os dados da carteira de investimento dos RPPS do RJ no mês de julho de 2020
dair_RJ2020JUL <- get_dair_carteira(sg_uf="RJ", dt_ano=2021, dt_mes_bimestre=7)

# Obtem os dados da carteira de investimento do RPPS de Quatis - RJ em
# todos os meses de 2021
dair_QuatisRJ <- get_crp(nr_cnpj_entidade = "39560008000148", dt_ano=2021)

## End(Not run)

marcosfs2006/ADPrev documentation built on Dec. 21, 2021, 1:50 p.m.