IBGE Data API

API para consumir e disponibilizar dados dos municípios brasileiros fornecidos pelo IBGE.

Conteúdo

• Sobre
  • Funcionalidades
  • Endpoints da API
  • Filtros
  • Exemplos
• Executando a aplicação
  • Conteinerizando a aplicação
• Autor
• Licença

Sobre

O IBGE Data API é uma interface desenvolvida com o framework FastAPI que permite obter os dados de todos os municípios brasileiros fornecidos pela API de Localidades do IBGE.

Assista este vídeo de exemplo no YouTube em https://www.youtube.com/watch?v=fNXMldLJKFY.

Funcionalidades

Os usuários podem obter todas as informações sobre os municípios brasileiros, assim como filtrar os dados por nome do município, região, mesorregião, microrregião, UF e ordenar os dados por cada um dos atributos mencionados. Além disso, também é possível ordenar as informações de ordem crescente e decrescente.

Endpoints da API

Método	Endpoint	Descrição
GET	/api/v1/municipalities	Obtém as informações de todos os municípios e permite uso de filtros.
GET	/api/v1/municipality/{id}	Obtém as informações de um município específico pelo ID.

Filtros

Filtro	Descrição
id	ID do município.
name	Nome do município ou caracteres iniciais.
region	Região do município.
mesoregion	Mesorregião do município.
microregion	Microrregião do município.
state	Estado (UF) do município.
order_by	Ordena as informações por um atributo específico.
descending	Ordena as informações por ordem crescente ou decrescente.

Exemplos

Consultando por cada um dos atributos:

foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipality/3304557' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?name=Brasília' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?region=Nordeste' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?mesoregion=Campinas' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?microregion=Ibiapaba' -H 'accept: application/json'
foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?state=CE' -H 'accept: application/json'

Mesclando os atributos:

foo@bar:~$ curl -X 'GET' 'http://localhost:8000/api/v1/municipalities?name=Santo&mesoregion=Campinas&order_by=name&descending=false' -H 'accept: application/json'

Executando a aplicação

Com o Git instalado, clone o repositório do projeto:

foo@bar:~$ git clone https://github.com/lucapwn/ibge-data-api.git

Com o Python instalado, navegue até o diretório do projeto e instale as dependências da aplicação:

foo@bar:~$ pip install -r requirements.txt

Execute o servidor da aplicação:

foo@bar:~$ fastapi run

Conteinerizando a aplicação

Com o Docker instalado, se necessitar realizar a conteinerização da aplicação, construa a imagem do contêiner:

foo@bar:~$ docker build -t ibge-data-api .

Por fim, execute o contêiner da aplicação:

foo@bar:~$ docker run -d -p 8000:8000 ibge-data-api

Você poderá acessar a documentação Swagger da aplicação em seu computador em http://localhost:8000/docs.

Autor

Desenvolvido por Lucas Araújo.

Licença

Esse software é licenciado pelo MIT.