Biblioteca

IBGE

Serviço

Buscar dados de municípios


Descrição

Realiza a busca de informações referentes aos municípios de todo território brasileiro, a partir de informações como UF, Código de UF, Município e Código de município.


Parâmetros para utilização da library

É necessário que ao menos 1 (um) dos parâmetros abaixo seja informado para que a busca aconteça:

{
  "municipio": "São Paulo",
  "codigoMunicipio": "3550308",
  "estado": "SP",
  "codigoEstado": "35"
}


Observação:
Não é possível realizar a busca passando duas informações de Município e/ou Estado devido a possibilidade de divergência das informações.

Quando temos:

{
  "municipio": "São Paulo",
  "codigoMunicipio": "123456"
}

Ou

{
  "estado": "SP",
  "codigoEstado": "35"
}


O valor de "municipio" pode ser válido (ex.: São Paulo) e o de "codigoMunicipio" pode não ser válido (ex.: 123abc), ou também podemos ter informações válidas para os dois campos mas que são referentes a municípios diferentes.

Portanto não será possível realizar a busca por conta de "município" não corresponder ao "codigoMunicipio" e vice-versa.

O mesmo acontece para "estado" e "codigoEstado".


Resultado da busca

Sucesso

Entrada:

{
  "codigoMunicipio": "3550308"
}

Saída:

{
  "municipio": [
    {
      "id": 3550308,
      "nome": "São Paulo",
      "microrregiao": {
        "id": 35061,
        "nome": "São Paulo",
        "mesorregiao": {
          "id": 3515,
          "nome": "Metropolitana de São Paulo",
          "UF": {
            "id": 35,
            "sigla": "SP",
            "nome": "São Paulo",
            "regiao": {
              "id": 3,
              "sigla": "SE",
              "nome": "Sudeste"
            }
          }
        }
      }
    }
  ],
  "message": "Município encontrado.",
  "success": true
}


Falha

Entrada:

{
  "codigoMunicipio": "123456789"
}

Saída:

{
  "municipio": [],
  "message": "Nenhum Município encontrado a partir do 'codigoMunicipio' informado.",
  "success": false
}



Encontrou sua resposta?