DadosAbertosBrasil.ibge

Módulo para captura de dados abertos das APIs do IBGE.

Este módulo fornece acesso a diversas informações do Instituto Brasileiro de Geografia e Estatística (IBGE), incluindo dados geográficos, demográficos e estatísticos.

Serviços Disponíveis

• IBGE Cidades: Informações sobre municípios brasileiros.

• Nomes 2.0: Estatísticas sobre nomes mais comuns no Brasil.

• Agregados 3.0 (SIDRA): Dados de séries temporais e tabelas estatísticas.

• Malhas Geográficas 2.0: Arquivos geoespaciais do Brasil.

• Projeções 1.0: Projeções populacionais e estatísticas futuras.

• Localidades 1.0: Informações detalhadas sobre unidades territoriais.

Mini-Tutorial de SIDRA

1. Importe o módulo ibge:

from DadosAbertosBrasil import ibge

2. Utilize lista_tabelas para encontrar a tabela desejada:

ibge.lista_tabelas(...)

3. Use lista_pesquisas e referencias para facilitar a busca:

pesquisas = ibge.lista_pesquisas(...)
referencias = ibge.referencias(...)

4. Após obter o código numérico da tabela, instancie um objeto Metadados:

dados = ibge.Metadados(tabela)

5. Verifique os valores disponíveis para consulta na tabela:

print(dados.periodos)
print(dados.variaveis)
print(dados.localidades)
print(dados.classificacoes)

6. Use os valores dos metadados para alimentar a função sidra:

ibge.sidra(...)

APIs Originais

• IBGE Cidades: https://cidades.ibge.gov.br/

• Serviços IBGE: https://servicodados.ibge.gov.br/api/docs

• SIDRA: http://api.sidra.ibge.gov.br/

class DadosAbertosBrasil.ibge._cidades.Galeria(localidade: int | str, verificar_certificado: bool = True)

Base: object

Gera uma galeria de fotos da localidade desejada.

Parameters

localidadeint

Código IBGE da localidade. O código pode ser obtido com auxílio da função ibge.localidades.

verificar_certificadobool, default=True

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

Attributes

fotografiaslist[ibge._Fotografia]

Lista de fotografias da localidade.

localidadeint

Código IBGE da localidade.

Examples

Instanciar a galeria de fotos de Fortaleza.

>>> fortaleza = ibge.Galeria(2304400)

Visualizar lista de fotografias dentro da galeria.

>>> fortaleza.fotografias

Selecionar primeira fotografia da galeria.

>>> foto = fortaleza[0]

Gerar uma URL da fotografia com altura máxima de 500 pixels.

>>> foto(altura=500)
'https://servicodados.ibge.gov.br/api/v1/resize/image?maxwidth=600&max...'

Notes

API original do IBGE Cidades

https://cidades.ibge.gov.br/

class DadosAbertosBrasil.ibge._cidades.Historia(localidade: int | str, verificar_certificado: bool = True)

Base: object

Histórico de uma localidade.

Parameters

localidadeint or str

Código da localidade. Este código pode ser obtido com auxílio da função ìbge.localidades.

verificar_certificadobool, default=True

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

Attributes

anoint

Ano da publicação do histórico.

estadostr

Nome do estado no formato ‘Estado - UF’.

estado1str

Nome do estado sem a sigla.

formacao_administrativastr

Descrição da formação administrativa da localidade.

gentilicostr

Gentílico dos naturais desta localidade.

historicostr

Texto descrevendo a história da localidade.

historico_fontestr

Fonte do texto do atributo historico.

localidadeint

Código da localidade.

municipiostr

Nome do município.

Raises

DAB_LocalidadeError

Caso o código da localidade seja inválido.

Examples

Capturar o histórico de Belo Horizonte e a fonte do texto.

>>> bh = ibge.Historia(localidade=310620)
>>> bh.historico
'Foi à procura de ouro que, no distante 1701, o bandeirante João Leite...'

>>> bh.historico_fonte
'Belo Horizonte (MG). Prefeitura. 2014. Disponível em: ...'

Capturar o histórico do estado de Minas Gerais >>> mg = ibge.Historia(52)

Notes

API original do IBGE Cidades

https://cidades.ibge.gov.br/

DadosAbertosBrasil.ibge._misc.coordenadas(formato: Literal['pandas', 'url'] = 'pandas') → DataFrame | str

Obtém as coordenadas de todas as localidades brasileiras, incluindo latitude, longitude e altitude.

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

Coordenadas de todas as localidade brasileiras.

Examples

>>> ibge.coordenadas()
       GM_PONTO     ID     CD_GEOCODIGO    TIPO   CD_GEOCODBA NM_BAIRRO  ...
0           NaN      1  110001505000001  URBANO  1.100015e+11   Redondo  ...
1           NaN      2  110001515000001  URBANO           NaN       NaN  ...
2           NaN      3  110001520000001  URBANO           NaN       NaN  ...
3           NaN      4  110001525000001  URBANO           NaN       NaN  ...
4           NaN      5  110001530000001  URBANO           NaN       NaN  ...
..          ...     ..              ...     ...           ...       ...  ...

DadosAbertosBrasil.ibge._misc.localidades(nivel: Literal['distritos', 'estados', 'mesorregioes', 'microrregioes', 'municipios', 'regioes-imediatas', 'regioes-intermediarias', 'regioes', 'paises'] = 'distritos', divisoes: Literal['distritos', 'estados', 'mesorregioes', 'microrregioes', 'municipios', 'regioes-imediatas', 'regioes-intermediarias', 'regioes', 'paises'] | None = None, localidade: Annotated[int, Gt(gt=0)] | str | list[Annotated[int, Gt(gt=0)] | str] = None, ordenar_por: str | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Obtém o conjunto de localidades do Brasil e suas intrarregiões.

Parameters

nivelstr, default=”distritos”

Nível geográfico dos dados.

divisoesstr, optional

Subdiviões intrarregionais do nível. Se None, captura todos os registros do nivel.

localidadeint | str | list[int|str], optional

ID (os lista de IDs) da localidade que filtrará o nivel.

ordenar_porstr, optional

Coluna pela qual a tabela será ordenada.

indexbool, default=False

Se True, defina a coluna “id” como 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]

Localidades desejadas.

Raises

DAB_LocalidadeError

Caso o nível geográfico seja inválido.

Examples

Captura todos os estados do Brasil

>>> ibge.localidades(nivel="estados")
    id sigla                 nome  regiao_id regiao_sigla   regiao_nome
0   11    RO             Rondônia          1            N         Norte
1   12    AC                 Acre          1            N         Norte
2   13    AM             Amazonas          1            N         Norte
3   14    RR              Roraima          1            N         Norte
4   15    PA                 Pará          1            N         Norte
.. ...   ...                  ...        ...          ...           ...

Captura todos os distritos do Brasil, colocando o ID como index.

>>> ibge.localidades(index=True)
                          nome  municipio_id  ... regiao_sigla   regiao_nome
id                                            ...                           
520005005      Abadia de Goiás       5200050  ...           CO  Centro-Oeste
310010405  Abadia dos Dourados       3100104  ...           SE       Sudeste
520010005            Abadiânia       5200100  ...           CO  Centro-Oeste
520010010       Posse d'Abadia       5200100  ...           CO  Centro-Oeste
310020305               Abaeté       3100203  ...           SE       Sudeste
...                        ...           ...  ...          ...           ...

Captura todos os municípios do estado do Rio de Janeiro (localidade=33)

>>> ibge.localidades(nivel="estados", divisoes="municipios", localidade=33)
         id                nome  microrregiao_id           microrregiao_nome      0   3300100      Angra dos Reis            33013         Baía da Ilha Grande   
1   3300159             Aperibé            33002      Santo Antônio de Pádua   
2   3300209            Araruama            33010                       Lagos   
3   3300225               Areal            33005                   Três Rios   
4   3300233  Armação dos Búzios            33010                       Lagos   
..      ...                 ...              ...                         ...

Notes

API original de códigos de localidades

https://servicodados.ibge.gov.br/api/docs/localidades

DadosAbertosBrasil.ibge._misc.malha(localidade: Annotated[int, Gt(gt=0)], nivel: str = 'estados', divisoes: str | None = None, periodo: Annotated[int, Gt(gt=0)] = 2020, formato: Literal['svg', 'json', 'geojson'] = 'geojson', qualidade: Literal['minima', 'intermediaria', 'maxima'] = 'minima') → str | dict

Obtém a URL para a malha referente ao identificador da localidade.

Parameters

localidadeint

Código da localidade desejada. Utilize a função ibge.localidades para identificar a localidade.

nivelstr, default=’estados’

Nível geográfico dos dados.

divisoesstr, optional

Subdiviões intrarregionais do nível. Se None, apresenta a malha sem subdivisões.

periodoint, default=2020

Ano da revisão da malha.

formato{‘svg’, ‘json’, ‘geojson’}, default=’svg’

Formato dos dados da malha.

qualidade{‘minima’, ‘intermediaria’, ‘maxima’}, default=’minima’

Qualidade de imagem da malha.

Returns

str

Se formato=’svg’, retorna a URL da malha da localidade desejada.

dict

Se formato=’json’, retorna a malha em formato TopoJSON.

dict

Se formato=’geojson’, retorna a malha em formato GeoJSON.

Raises

DAB_LocalidadeError

Caso o nível geográfico seja inválido.

Notes

API original das malhas territoriais

https://servicodados.ibge.gov.br/api/docs/malhas?versao=3

Examples

Captura a malha do Distrito Federal (localidade=53) em formato GeoJSON.

>>> ibge.malha(localidade=53, formato='geojson')
{'type': 'FeatureCollection',
    'features': [{'type': 'Feature',
        'geometry': {'type': 'Polygon',
            'coordinates': [[[-47.31, -16.0363], ...

Captura a malha de Joinville em formato SVG com qualidade mínima.

>>> ibge.malha(
...     nivel = 'municipios',
...     localidade = 4209102,
...     formato = 'svg',
...     qualidade = 'minima'
... )
'https://servicodados.ibge.gov.br/api/v3/malhas/municipios/4209102?...'

Captura a malha do Brasil subdividido por UF em formato TopoJSON.

>>> ibge.malha(
...     nivel = 'paises',
...     localidade = 'BR',
...     divisoes = 'uf',
...     formato = 'json'
... )
{'type': 'Topology',
    'arcs': [[[32967, 111009], [-821, 372]],
        [[32146, 111381],
        [133, 124],
        [15, 106], ...

DadosAbertosBrasil.ibge._misc.populacao(projecao: Literal['populacao', 'nascimento', 'obito', 'incremento'] | None = None, localidade: Annotated[int, Gt(gt=0)] | None = None) → dict | int

Obtém a projecao da população referente ao Brasil.

Parameters

projecao{‘populacao’, ‘nascimento’, ‘obito’, ‘incremento’}, optional

• ‘populacao’ obtém o valor projetado da população total da localidade;

• ‘nascimento’ obtém o valor projetado de nascimentos da localidade

• ‘obito’ obtém o valor projetado de óbitos da localidade;

• ‘incremento’ obtém o incremento populacional projetado.

• None obtém um dicionário com todos os valores anteriores.

localidadeint, optional

Código da localidade desejada. Por padrão, obtém os valores do Brasil. Utilize a função ibge.localidades para identificar a localidade desejada.

Returns

dict

Dicionário de projeções.

int

Valor projetado para o indicador escolhido.

Raises

DAB_LocalidadeError

Caso código da localidade seja inválido.

ValueError

Caso o argumento projecao seja inválido.

Examples

Projeção de óbito do Brasil.

>>> ibge.populacao('obito')
45000

Obter dados do Rio de Janeiro (localidade 33)

>>> ibge.populacao(localidade=33)
{
    'localidade': '33',
    'horario': '03/07/2021 19:15:48',
    'projecao': {
        'populacao': 17459953,
        'periodoMedio': {
            'incrementoPopulacional': 330508
        }
    }
}

DadosAbertosBrasil.ibge._nomes.nomes(nomes: list[str] | str, sexo: Literal['f', 'm'] | None = None, localidade: Annotated[int, Gt(gt=0)] | None = None, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Obtém a frequência de nascimentos por década dos nomes consultados.

Defina o campo nomes com um string ou uma lista de string. Use os argumentos opcionais para definir sexo e localidade dos nomes.

Parameters

nomeslist or str

Nome ou lista de nomes a ser consultado.

sexo{‘f’, ‘m’}, optional

• ‘F’ para consultar apenas o nome de pessoas do sexo feminino;

• ‘M’ para consultar apenas o nome de pessoas do sexo masculino;

• None para consultar ambos.

localidadeint, optional

Caso deseje obter a frequência referente a uma dada localidade, informe o parâmetro localidade. Por padrão, assume o valor BR, mas pode ser o identificador de um município ou de uma UF. Utilize a função ibge.localidade para encontrar a localidade desejada.

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]

Frequência de nascimentos por década para os nomes consultados.

Raises

DAB_LocalidadeError

Caso o código da localidade seja inválido.

Examples

Forma mais simples da função.

>>> ibge.nomes('Joao')
nome           JOAO
periodo
1930[         60155
[1930,1940[  141772
[1940,1950[  256001
[1950,1960[  396438
[1960,1970[  429148
[1970,1980[  279975
[1980,1990[  273960
[1990,2000[  352552
[2000,2010[  794118

Quantidade de nascimento de “João” no Rio de Janeiro (localidade 33) e do sexo masculino (‘M’).

>>> ibge.nomes('Joao', sexo='M', localidade=33)
nome          JOAO
periodo
1930[         3592
[1930,1940[   9207
[1940,1950[  16860
[1950,1960[  25221
[1960,1970[  25839
[1970,1980[  15477
[1980,1990[  16114
[1990,2000[  26862
[2000,2010[  68741

DadosAbertosBrasil.ibge._nomes.nomes_ranking(decada: Annotated[int, Gt(gt=0)] | None = None, sexo: Literal['f', 'm'] | None = None, localidade: Annotated[int, Gt(gt=0)] | None = None, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Obtém o ranking dos nomes segundo a frequência de nascimentos por década.

Parameters

decadaint, optional

Deve ser um número múltiplo de 10 no formato AAAA.

sexo{‘f’, ‘m’}, optional

• ‘F’ para consultar apenas o nome de pessoas do sexo feminino;

• ‘M’ para consultar apenas o nome de pessoas do sexo masculino;

• None para consultar ambos.

localidadeint, optional

Caso deseje obter o ranking de nomes referente a uma dada localidade, informe o parâmetro localidade. Por padrão, assume o valor BR, mas pode ser o identificador de um município ou de uma UF. Utilize a função ibge.localidade para encontrar a localidade desejada.

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]

Nomes mais populadores dentro do universo de parâmetros pesquisados.

Raises

DAB_LocalidadeError

Caso o código da localidade seja inválido.

Examples

Forma mais simples da função.

>>> ibge.nomes_ranking()
            nome  frequencia
ranking
1            MARIA    11734129
2             JOSE     5754529
3              ANA     3089858
4             JOAO     2984119
..             ...         ...

Ranking de nomes femininos no Rio de Janeiro na decada de 1990.

>>> ibge.nomes_ranking(decada=1990, localidade=33, sexo='F')
            nome  frequencia
ranking
1              ANA       44284
2            MARIA       27944
3            ALINE       26084
4          VANESSA       24225
..             ...         ...

DadosAbertosBrasil.ibge._nomes.nomes_uf(nome: str, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Obtém a frequência de nascimentos por UF para o nome consultado.

Parameters

nomestr

Nome que se deseja pesquisar.

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]

Frequência de nascimentos do nome pesquisado, agrupado por Unidade da Federação.

Examples

>>> ibge.nomes_uf('Joao')

populacao frequencia proporcao

localidade 11 1562409 23366 1495.51 12 733559 10383 1415.43 13 3483985 41234 1183.53 14 450479 5664 1257.33 .. … … …

class DadosAbertosBrasil.ibge._sidra.Metadados(tabela: int)

Base: object

Metadados da tabela desejada.

Parameters

tabelaint

Código numérico da tabela desejada. Utilize a função ibge.lista_tabelas para encontrar o código.

Attributes

dadosdict

Lista completa de metadados da tabela.

codint

Código numérico da tabela.

nomestr

Nome da tabela.

assuntostr

Assunto da tabela.

periodosdict

Dicionário contendo a frequência, início e fim da tabela.

localidadesdict

Dicionário contendo os níveis territoriais da tabela.

variaveislist of dict

Lista de variáveis disponíveis para a tabela.

classificacoeslist of dict

Lista de classificações e categorias disponíveis para a tabela.

Examples

1. Crie uma instância de Metadados utilizando o código da tabela SIDRA como argumento.

>>> m = ibge.Metadados(tabela=1301)

2. Chame os atributos para obter informações sobre a tabela.

>>> m.nome
'Área e Densidade demográfica da unidade territorial'
>>> m.assunto
'Território'
>>> m.periodos
{'frequencia': 'anual', 'inicio': 2010, 'fim': 2010}

DadosAbertosBrasil.ibge._sidra.lista_pesquisas(index: bool = False) → DataFrame

Lista de pesquisas disponíveis no SIDRA.

Esta função é utilizada para identificar o código usado pela função ibge.lista_tabelas.

Parameters

indexbool, default=False

Se True, define a coluna ‘pesquisa_id’ como index do DataFrame.

Returns

pandas.core.frame.DataFrame

Lista de pesquisas disponíveis no SIDRA.

Examples

>>> ibge.lista_pesquisas()
   pesquisa_id                                      pesquisa_nome
0           CL                       Cadastro Central de Empresas
1           CA                                 Censo Agropecuário
2           ME           Censo Comum do Mercosul, Bolívia e Chile
3           CD                                  Censo Demográfico
4           CM                             Contagem da População
..         ...                                                ...

DadosAbertosBrasil.ibge._sidra.lista_tabelas(contendo: str | None = None, excluindo: str | None = None, assunto: int | str | None = None, classificacao: int | str | None = None, periodo: dict | str | None = None, periodicidade: int | str | None = None, nivel: int | str | None = None, pesquisa: str | None = None, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Lista de tabelas disponíveis no SIDRA.

Parameters

contendostr, optional

Termo que deve estar contido no nome ou no comentário da série.

excluindostr | list[str], optional

Termo ou lista de termos que não pode aparecer no nome da série. Sobrepõe o argumento contendo.

assuntostr | int, optional

Busque apenas as tabelas referentes ao assunto desejado. Os assuntos são identificados por um código numérico e podem ser obtidos com auxílio da função ibge.referencias(‘a’). Exemplo: O assunto “Abate de Animais” possui o código 70, portanto pesquise por tabelas deste assunto pelo argumento assunto=70.

classificacaostr | int, optional

Busque apenas as tabelas referentes à classificação desejada. As classificações são identificadas por um código numérico e podem ser obtidas com auxílio da função ibge.referencias(‘c’). Exemplo: A classificação “Agricultura familiar” possui o código 12896, portanto pesquise por tabelas contendo essa classificação através do argumento classificacao=12896.

periododict | str, optional

Busque apenas as tabelas referentes ao período desejado. Os períodos devem ser um dicionário no formato {periodicidade:periodo} ou um string no formato ‘Px[xxxxxx]’. Exemplo: {5: 202001} ou ‘P5[202001]’. Obtém as pesquisas cujos agregados disponibilizam resultados para o mês (P5) de janeiro de 2020 (202001). Observe que é necessário informar a periodicidade (P5), devido a períodos que compartilham o mesmo identificador - 202001 pode significar o mês de Janeiro de 2020, o primeiro trimestre de 2020 ou ainda o primeiro semestre de 2020. A função ibge.referencias(‘p’) retorna todos os períodos disponíveis.

periodicidadestr | int, optional

Busque apenas as tabelas que contém essa periodicidade de divulgação. Utilize a função ibge.referencias(‘e’) para encontrar o código. Exemplo: A periodicidade “mensal” possui o código 5, portanto pesquise por tabelas de periodicidade mensal através do argumento periodicidade=5.

nivelstr | int, optional

Busque apenas as tabelas disponíveis neste nível geográfico. Utilize a função ibge.referencias(‘n’) para encontrar o código. Exemplo: O nível “Município” possui o código 6, portanto pesquise por tabelas contendo esse nível geográfico através do argumento nivel=6.

pesquisastr, optional

Código de duas letras da pesquisa que será buscada. Utilize a função ibge.lista_pesquisas para encontrar o código.

indexbool, default=False

Se True, define a coluna ‘tabela_id’ como 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]

Lista de tabelas disponíveis no SIDRA.

Examples

Forma mais simples da função. Retorna todas as tabelas.

>>> ibge.lista_tabelas()

Listas tabelas cujo assunto é “Trabalho” (17), com periodicidade trimestral (9) a um nível geográfico municipal (6) contendo classificação por grupo de idade (58).

>>> ibge.lista_tabelas(
...     assunto = 17,
...     periodicidade = 9,
...     nivel = 6,
...     classificacao = 58
... )

Listar tabelas do Censo Demográfico (pesquisa ‘CD’), contendo o termo ‘rendimento’ no título, porém não contendo ‘Distribuição’, definindo a coluna tabela_id como index do DataFrame.

>>> ibge.lista_tabelas(
...     pesquisa = 'CD',
...     contendo = 'rendimento',
...     excluindo = 'distribuição',
...     index = True
... )

Buscar por tabelas que contenham o IPCA de Dezembro de 2019 (P5[201912]).

>>> ibge.lista_tabelas(
...     contendo = 'ipca',
...     periodo = {5: 201912}
... )

DadosAbertosBrasil.ibge._sidra.referencias(cod: Literal['assuntos', 'classificacoes', 'niveis', 'periodos', 'periodicidades', 'territorios', 'variaveis'], index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Obtém uma base de códigos para utilizar como argumento na busca do SIDRA.

Parameters

codstr

Uma das referências a seguir: - “assuntos” - “classificacoes” - “niveis” - “periodos” - “periodicidades” - “territorios” - “variaveis”

index: bool, default=False

Defina True caso o campo “cod” deva 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]

Referências do código pesquisado.

Examples

Lista assuntos.

>>> ibge.referencias("assuntos")
     cod                                    referencia
0    148                         Abastecimento de água
1     70                              Abate de animais
2    110                Acesso a esgotamento sanitário
3    147                             Acesso à internet
4    107  Acesso a serviço de coleta de lixo doméstico
..    ..                                            ..

Lista classificações usando o cod da classificação como index do DataFrame.

>>> ibge.referencias("classificacoes", index=True)
                                              referencia
cod
588    Acessibilidade possível na maior parte das via...
957    Acesso à Internet por telefone móvel celular p...
681                    Acesso a televisão por assinatura
12236                               Adequação da moradia
806                      Adubação, calagem e agrotóxicos
...                                                  ...

DadosAbertosBrasil.ibge._sidra.sidra(tabela: int, periodos: list | int | str = 'last', variaveis: list | int | str = 'allxp', localidades: dict = {1: 'all'}, classificacoes: dict | None = None, ufs_extintas: bool = False, decimais: int | None = None, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Função para captura de dados do SIDRA - Sistema IBGE de Recuperação Automática.

Parameters

tabelaint

Código numérico identificador da tabela.

periodoslist or int or str, default=’last’

Períodos de consulta desejados: - ‘last’: Último período; - ‘last n’: Últimos n períodos; - ‘first’: Primeiro período; - ‘first n’: Primeiros n períodos; - ‘all’: Todos os períodos disponíveis; - list: Lista de períodos desejados; - int: Um período específico; - Range de períodos separados por hífen.

variaveislist or int or str, default=’allxp’

Variáveis de consulta desejadas: - ‘all’: Todas as variáveis disponíveis; - ‘allxp’: Todas as variáveis, exceto as percentuais; - list: Lista de variáveis; - int: Uma variáveis específica.

localidadesdict, default={1:’all’}

Localidades por nível territorial. As chaves dos dicionários devem ser o código de nível territorial: - 1: Brasil; - 2: Grande região (N, NE, SE, S, CO); - 3: Unidade da Federação (UFs); - 6: Município; - 7: Região metropolitana; - 8: Mesorregião geográfica; - 9: Microrregião geográfica; - 13: Região metropolitana e subdivisão; - 14: Região Integrada de Desenvolvimento; - 15: Aglomeração urbana. Os valores do dicionário devem ser: - ‘all’: Todas as localidades do nível territorial. - list: Códigos dos territórios desejados. - int: Um território específico.

classificacoesdict, optional

Dicionário de classificações e categorias. As chaves do dicionário devem ser o código da classificação. Os valores do dicionário devem ser: - ‘all’: Todas as categorias desta classificação; - ‘allxt’: Todas as categorias, exceto as totais; - list: Lista de categorias desejadas; - int: Uma categoria específica.

ufs_extintasbool, default=False

Se True, adiciona as UFs extintas (se disponível na tabela). - 20: Fernando de Noronha - 34: Guanabara

decimaisint, optional

Número de fixo de casas decimais do resultado, entre 0 e 9. Se None, utiliza o padrão de cada variável.

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]

Série de dados do SIDRA.