DadosAbertosBrasil.favoritos

Módulo de consulta a informações de interesse público.

Este módulo reúne funções pré-parametrizadas de outros submódulos do DadosAbertosBrasil, facilitando o acesso a informações diversas e amplamente utilizadas.

As funções deste módulo são importadas automaticamente pelo __init__ do supermódulo, proporcionando uma interface simplificada para consultas rápidas.

DadosAbertosBrasil.favoritos.bandeira(uf: str, tamanho: Annotated[int, Gt(gt=0)] = 100) → str[código-fonte]

Gera a URL da WikiMedia para a bandeira de um estado.

Parameters

ufstr: Sigla da Unidade Federativa.
tamanhoint, default=100: Tamanho em pixels da bandeira.

Returns

str: URL da bandeira do estado no formato PNG.

Raises

DAB_UFError: Caso seja inserida uma UF inválida.

Examples

Gera o link para uma imagem da bandeira de Santa Catarina de 200 pixels.

>>> favoritos.bandeira(uf='SC', tamanho=200)
'https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/' ...

DadosAbertosBrasil.favoritos.brasao(uf: str, tamanho: Annotated[int, Gt(gt=0)] = 100) → str[código-fonte]

Gera a URL da WikiMedia para o brasão de um estado.

Parameters

ufstr: Sigla da Unidade Federativa.
tamanhoint, default=100: Tamanho em pixels da bandeira.

Returns

str: URL da bandeira do estado no formato PNG.

Raises

DAB_UFError: Caso seja inserida uma UF inválida.

Examples

Gera o link para uma imagem do brasão de Santa Catarina de 200 pixels.

>>> favoritos.brasao(uf='SC', tamanho=200)
'https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/' ...

DadosAbertosBrasil.favoritos.catalogo(formato: Literal['pandas', 'url'] = 'pandas') → DataFrame | str[código-fonte]

Catálogo de iniciativas oficiais de dados abertos no Brasil.

Parameters

formato{“pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.

Returns

pandas.core.frame.DataFrame | str: Catálogo de iniciativas de dados abertos.

Notes

Fonte dos dados: https://github.com/dadosgovbr

Examples

>>> favoritos.catalogo()
                                               Título  ...
0                      Alagoas em dados e informações  ...
1                             Fortaleza Dados Abertos  ...
2                              Dados abertos – TCM-CE  ...
3                      Dados abertos Distrito Federal  ...
4                       Dados abertos – Governo do ES  ...
..                                                ...  ...

DadosAbertosBrasil.favoritos.codigos_municipios(formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Lista dos códigos dos municípios do IBGE e do TSE.

Utilizado para correlacionar dados das duas APIs diferentes.

Parameters

formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: Códigos do IBGE e do TSE para todos os municípios do Brasil.

Notes

Fonte dos dados: https://github.com/betafcc

Examples

>>> favoritos.codigos_municipios()
      codigo_tse  codigo_ibge nome_municipio  uf  capital
0           1120      1200013     ACRELÂNDIA  AC        0
1           1570      1200054   ASSIS BRASIL  AC        0
2           1058      1200104      BRASILÉIA  AC        0
3           1007      1200138         BUJARI  AC        0
4           1015      1200179       CAPIXABA  AC        0
..           ...          ...            ...  ..      ...

DadosAbertosBrasil.favoritos.ipca(ultimos: Annotated[int, Gt(gt=0)] | None = None, inicio: date | None = None, fim: date | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Índice nacional de preços ao consumidor-amplo (IPCA).

Esta é uma função de fácil acesso à série temporal 433 do módulo bacen.

Parameters

ultimosint, optional: Retorna os últimos N valores da série numérica.
iniciodate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o primeiro dia da pesquisa.
fimdate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o último dia da pesquisa. Caso este campo seja None, será considerada a data de hoje.
indexbool, default=False: Define se a coluna ‘data’ será o index do DataFrame.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: DataFrame contendo os valores da série temporal.

Notes

Os argumentos inicio e fim devem ser usados em conjunto para funcionar.

Examples

Os quatro valores mais recentes.

>>> favoritos.ipca(ultimos=4)
        data valor
0 2021-03-01  0.93
1 2021-04-01  0.31
2 2021-05-01  0.83
3 2021-06-01  0.53

Os valores entre Janeiro e Abril de 2021 usando a data como índice.

>>> favoritos.ipca(inicio='2021-01-01', fim='2021-04-01', index=True)
           valor
data
2021-01-01  0.25
2021-02-01  0.86
2021-03-01  0.93
2021-04-01  0.31

DadosAbertosBrasil.favoritos.perfil_eleitorado(formato: Literal['pandas', 'url'] = 'pandas') → DataFrame | str[código-fonte]

Tabela com perfil do eleitorado por município.

Parameters

formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.

Returns

pandas.core.frame.DataFrame | str: Perfil do eleitorado em todos os municípios.

Examples

>>> favoritos.perfil_eleitorado()
      NR_ANO_ELEICAO  CD_PAIS NM_PAIS SG_REGIAO NM_REGIAO SG_UF     NM_UF  ...
0               2020        1  Brasil         N     Norte    AC      Acre  ...
1               2020        1  Brasil         N     Norte    AC      Acre  ...
..               ...      ...     ...       ...       ...   ...       ...  ...

DadosAbertosBrasil.favoritos.pib(periodo: Literal['anual', 'trimestral'] = 'anual', tipo: Literal['nominal', 'real'] = 'real', index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Variação percentual do Produto Interno Bruto Real.

Esta é uma função de fácil acesso às séries temporais de PIB do módulo ipea.

Parameters

periodo{“anual”, “trimestral”}, default=”anual”

Granularidade dos valores.

tipo{“nominal”, “real”}, default=”real”

“nominal”: Valores absolutos do PIB em reais;
“real”: Variação real do PIB no período.

indexbool, default=False

Define a coluna data como index da tabela.

formato{“json”, “pandas”, “url”}, default=”pandas”

Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.

verificar_certificadobool, default=True

Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: Valores do PIB real ou nominal.

Examples

Capturar PIB trimestral.

>>> favoritos.pib(periodo="trimestral")
          data      valor
0   1997-01-01   3.400572
1   1997-04-01   4.754002
2   1997-07-01   1.791279
3   1997-10-01   3.738518
4   1998-01-01   1.007575
..         ...        ...

Capturar PIB anual, pondo o período como index da tabela.

>>> favoritos.pib(periodo="anual", index=True)
               valor
data
1997-01-01  3.394846
1998-01-01  0.338098
1999-01-01  0.467938
2000-01-01  4.387949
2001-01-01  1.389896
...              ...

DadosAbertosBrasil.favoritos.rentabilidade_poupanca(ultimos: Annotated[int, Gt(gt=0)] | None = None, inicio: date | None = None, fim: date | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Rentailidade dos depósitos de poupança a partir de Maio de 2012.

Esta é uma função de fácil acesso à série temporal 195 do módulo bacen.

Parameters

ultimosint, optional: Retorna os últimos N valores da série numérica.
iniciodate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o primeiro dia da pesquisa.
fimdate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o último dia da pesquisa. Caso este campo seja None, será considerada a data de hoje.
indexbool, default=False: Define se a coluna ‘data’ será o index do DataFrame.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: DataFrame contendo os valores da série temporal.

Notes

Os argumentos inicio e fim devem ser usados em conjunto para funcionar.

Examples

Os quatro valores mais recentes.

>>> favoritos.rentabilidade_poupanca(ultimos=4)
        data    datafim   valor
0 2021-07-05 2021-08-05  0.2446
1 2021-07-06 2021-08-06  0.2446
2 2021-07-07 2021-08-07  0.2446
3 2021-07-08 2021-08-08  0.2446

Os valores entre Janeiro e Abril de 2021 usando a data como índice.

>>> favoritos.rentabilidade_poupanca(inicio="2021-01-01", fim="2021-04-01", index=True)
              datafim   valor
data
2021-01-01 2021-02-01  0.1159
2021-01-02 2021-02-02  0.1159
2021-01-03 2021-02-03  0.1159
2021-01-04 2021-02-04  0.1159
2021-01-05 2021-02-05  0.1159
...               ...     ...

DadosAbertosBrasil.favoritos.reservas_internacionais(periodo: Literal['diario', 'mensal'] = 'mensal', ultimos: Annotated[int, Gt(gt=0)] | None = None, inicio: date | None = None, fim: date | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Reservar internacionais mensais ou diárias.

Esta é uma função de fácil acesso às séries temporais 3546 e 13621 do módulo bacen.

Parameters

periodo{“mensal”, “diario”}, default=”mensal”: Período dos dados consultados.
ultimosint, optional: Retorna os últimos N valores da série numérica.
iniciodate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o primeiro dia da pesquisa.
fimdate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o último dia da pesquisa. Caso este campo seja None, será considerada a data de hoje.
indexbool, default=False: Define se a coluna “data” será o index do DataFrame.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: DataFrame contendo os valores da série temporal.

Notes

Os argumentos inicio e fim devem ser usados em conjunto para funcionar.

Examples

Os quatro valores diários mais recentes.

>>> favoritos.reservas_internacionais(periodo="diario", ultimos=4)
        data   valor
0 2021-07-05  353870
1 2021-07-06  354086
2 2021-07-07  354140
3 2021-07-08  354303

Os valores mensais entre Janeiro e Abril de 2021 usando a data como índice.

>>> favoritos.reservas_internacionais(
...     periodo = "mensal",
...     inicio = "2021-01-01",
...     fim = "2021-04-01",
...     index = True
... )
             valor
data
2021-01-01  355416
2021-02-01  356070
2021-03-01  347413
2021-04-01  350996

DadosAbertosBrasil.favoritos.risco_brasil(index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Valores diários do Risco-Brasil, disponibilizados pela J.P. Morgan desde 1994.

Esta é uma função de fácil acesso à série temporal ‘JPM366_EMBI366’ do módulo ipea.

Parameters

indexbool, default=False: Define a coluna data como index da tabela.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: Tabela contendo os valores diários do Risco-Brasil.

Examples

>>> favoritos.risco_brasil()
            data   valor
0     1994-04-29  1120.0
1     1994-04-30     NaN
2     1994-05-01     NaN
3     1994-05-02  1131.0
4     1994-05-03  1081.0
..           ...     ...

DadosAbertosBrasil.favoritos.salario_minimo(tipo: Literal['nominal', 'pcc', 'real'] = 'nominal', index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Valores do salário-mínimo mensal brasileiro desde 1940.

Esta é uma função de fácil acesso às série temporais do módulo ipea.

Parameters

tipo{“nominal”, “real”, “pcc”}, default=”nominal”: Tipo de salário-mínimo. - “nominal”: Salário-mínimo nominal; - “real”: Salário-mínimo real (abatido pela inflação); - “ppc”: Salario-mínimo por Paridade de Poder de Compra.
indexbool, default=False: Define a coluna data como index da tabela.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: Tabela contendo os valores mensais do salário-mínimo.

Examples

Forma mais simples da função.

>>> favoritos.salario_minimo()
           data         valor
0    1940-07-01  8.727273e-14
1    1940-08-01  8.727273e-14
2    1940-09-01  8.727273e-14
3    1940-10-01  8.727273e-14
4    1940-11-01  8.727273e-14
..          ...           ...

Salário-mínimo real usando a data como índice da tabela.

>>> favoritos.salario_minimo(tipo="real", index=True)
                  valor
data
1940-07-01   962.321161
1940-08-01   959.634185
1940-09-01   958.771291
1940-10-01   943.765421
1940-11-01   922.546843
...                 ...

DadosAbertosBrasil.favoritos.selic(periodo: Literal['diario', 'mensal', 'meta'] = 'meta', anualizado: bool = True, ultimos: Annotated[int, Gt(gt=0)] | None = None, inicio: date | None = None, fim: date | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Taxa de juros - Meta Selic definida pelo COPOM.

Esta é uma função de fácil acesso à série temporal 432 do módulo bacen.

Parameters

periodo{“meta”, “diario”, “mensal”}, default=”meta”: Tipo da série que será retornada. - “meta”: Meta anual do COPOM; - “diario”: Intervalo de dados por dia. - “mensal”: Intervalo de dados por mês.
anualizadobool, default=True: Se True, anualiza a série mantendo o período. Esse argumento é ignorado quando periodo == “meta”.
ultimosint, optional: Retorna os últimos N valores da série numérica.
iniciodate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o primeiro dia da pesquisa.
fimdate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o último dia da pesquisa. Caso este campo seja None, será considerada a data de hoje.
indexbool, default=False: Define se a coluna “data” será o index do DataFrame.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: DataFrame contendo os valores da série temporal.

Notes

Os argumentos inicio e fim devem ser usados em conjunto para funcionar.

Examples

Busca a taxa mensal anualizada dos quatro meses mais recentes.

>>> import DadosAbertosBrasil as dab
>>> dab.selic(
...     periodo = "mensal",
...     anualizado = True,
...     ultimos = 4
... )
        data  valor
0 2021-11-01   7.65
1 2021-12-01   8.76
2 2022-01-01   9.15
3 2022-02-01  10.47

Captura a meta SELIC corrente.

>>> dab.selic(periodo="meta", ultimos=1)
        data  valor
0 2022-03-16  10.75

Captura os valores não anualizados da primeira semada de Janeiro/2022, utilizando a data como índice.

>>> dab.selic(
...     periodo = "diario",
...     anualizado = False,
...     inicio = "2022-01-03",
...     fim = "2022-01-07",
...     index = True
... )
               valor
data
2022-01-03  0.034749
2022-01-04  0.034749
2022-01-05  0.034749
2022-01-06  0.034749
2022-01-07  0.034749

DadosAbertosBrasil.favoritos.taxa_referencial(ultimos: Annotated[int, Gt(gt=0)] | None = None, inicio: date | None = None, fim: date | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict][código-fonte]

Taxa referencial (TR).

Esta é uma função de fácil acesso à série temporal 226 do módulo bacen.

Parameters

ultimosint, optional: Retorna os últimos N valores da série numérica.
iniciodate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o primeiro dia da pesquisa.
fimdate, optional: Valor datetime ou string no formato de data “AAAA-MM-DD” que representa o último dia da pesquisa. Caso este campo seja None, será considerada a data de hoje.
indexbool, default=False: Define se a coluna ‘data’ será o index do DataFrame.
formato{“json”, “pandas”, “url”}, default=”pandas”: Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.
verificar_certificadobool, default=True: Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]: DataFrame contendo os valores da série temporal.

Notes

Os argumentos inicio e fim devem ser usados em conjunto para funcionar.

Examples

Os quatro valores mais recentes.

>>> favoritos.taxa_referencial(ultimos=4)
        data    datafim   valor
0 2021-07-05 2021-08-05  0.0000
1 2021-07-06 2021-08-06  0.0000
2 2021-07-07 2021-08-07  0.0000
3 2021-07-08 2021-08-08  0.0000

Os valores entre Janeiro e Abril de 2021 usando a data como índice.

>>> favoritos.taxa_referencial(inicio="2021-01-01", fim="2021-04-01", index=True)
              datafim   valor
data
2021-01-01 2021-02-01  0.0000
2021-01-02 2021-02-02  0.0000
2021-01-03 2021-02-03  0.0000
2021-01-04 2021-02-04  0.0000
2021-01-05 2021-02-05  0.0000
...               ...     ...