API do Banco de Nomes Geográficos do Brasil (BNGB)

API e documentação

Versão: 1.0.1

API referente ao Banco de Nomes Geográficos do Brasil (BNGB).

O Banco de Nomes Geográficos do Brasil (BNGB) reúne os nomes geográficos* das categorias hidrografia, relevo, limites e localidades contidos, principalmente, nas bases cartográficas vetoriais contínuas produzidas pelo IBGE em diferentes escalas. Sua criação teve como principais objetivos subsidiar a padronização dos nomes no âmbito do IBGE e disseminar para a sociedade os nomes geográficos brasileiros.
Os nomes geográficos presentes nas bases cartográficas produzidas pelo IBGE são inseridos no BNGB onde são tratados, compatibilizados, padronizados e atualizados nas diferentes escalas cartográficas, assim uma feição geográfica representada em várias escalas deverá possuir um mesmo nome e um mesmo identificador no BNGB.
A padronização dos nomes geográficos é crucial para fomentar uma comunicação clara, melhorar o deslocamento pelo território e para promover a identidade cultural, entre outros tantos benefícios.
No BNGB há nomes “validados”, isto é, nomes que já passaram por uma análise, e nomes “não validados”, que são aqueles que ainda não foram analisados, porém fazem parte das bases cartográficas vetoriais contínuas.
O BNGB permite pesquisas por nome geográfico ou palavra/termo, por categoria e/ou classe de informação, por escala cartográfica, por validação, por UF e/ou município, por recorte espacial, dentre outras.

* Nomes geográficos são substantivos próprios que nomeiam feições terrestres. Em geral são formados por um conjunto, que se compõe de um termo genérico, que define o tipo da feição e um termo específico que particulariza o elemento nominado. No nome geográfico “Praia Vermelha”, “Praia” é o termo genérico e “Vermelha” o específico. Também podem fazer parte do nome geográfico os termos “de”, “da/do”, “das/dos” chamados de conectivos e o termo “ou” que introduz um nome variante, como “Rio das Contas ou Rio das Flores”.
Os nomes geográficos carregam em si informações importantes do grupo humano que os instituiu, tais como a língua, a cultura e a história, entre outras e, por isso, fazem arte do patrimônio cultural de um povo e/ou nação.
Recebem nomes geográficos lugares habitados (cidades, vilas etc), divisões administrativas (estados, municípios, distritos, bairros etc), feições naturais (cursos de água, montanhas, cabos, lagos, mares etc), e construídas (barragens, aeroportos, autoestradas etc) e lugares sem limites precisos ou áreas com significado local específico (quase sempre religioso), como pastagens, áreas de pesca, lugares sagrados.

Nome Geográfico

Obtém um único nome geográfico a partir do identificador informado.

https://servicodados.ibge.gov.br/api/v1/bngb/nomegeografico/{identificador}

Parâmetros

Name	Description
identificador*

Responses

Status: 200 - Um conjunto de nomes geográficos do BNGB em formato geojson

Schema

Nomes Geográficos por padrão

Obtém os nomes geográficos que tenham o padrão informado no nome.

https://servicodados.ibge.gov.br/api/v1/bngb/padrao/{padrao}/nomesgeograficos

Parâmetros

Name	Description
padrao*

Query parameters

Name	Description
statusValidacao
tipoGeom
categoria
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por município

Obtém os nomes geográficos localizadas em um determinado município a partir do geocódigo informado.

https://servicodados.ibge.gov.br/api/v1/bngb/municipio/{geocodigo}/nomesgeograficos

Parâmetros

Name	Description
geocodigo*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
categoria
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por unidade da federação

Obtém os nomes geográficos localizados em um estado a partir da sigla de identificação da unidade da federação informada.

https://servicodados.ibge.gov.br/api/v1/bngb/uf/{sigla}/nomesgeograficos

Parâmetros

Name	Description
sigla*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
categoria
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por proximidade

Obtém os nomes geográficos localizados próximos a coordenada informada, considerando uma distância em Km.

https://servicodados.ibge.gov.br/api/v1/bngb/proximidade/{lat}/{lon}/{km}/nomesgeograficos

Parâmetros

Name	Description
lat*
lon*
km*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
categoria
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por enquadramento

Obtém os nomes geográficos localizados no retângulo envolvente definido pelas coordenadas informadas.

https://servicodados.ibge.gov.br/api/v1/bngb/enquadramento/{lonW}/{latS}/{lonE}/{latN}/nomesgeograficos

Parâmetros

Name	Description
lonW*
latS*
lonE*
latN*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
categoria
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por categoria

Obtém os nomes geográficos que pertencem a categoria informada.

https://servicodados.ibge.gov.br/api/v1/bngb/categoria/{categoria}/nomesgeograficos

Parâmetros

Name	Description
categoria*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
classe
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Nomes Geográficos por classe

Obtém os nomes geográficos que pertencem a classe informada.

https://servicodados.ibge.gov.br/api/v1/bngb/classe/{classe}/nomesgeograficos

Parâmetros

Name	Description
classe*

Query parameters

Name	Description
statusValidacao
tipoGeom
padrao
escalaOcorrencia
formato
nrMaxNomesGeograficos

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Schema

Lista de categorias

Obtém uma lista de categorias, de acordo com a EDGV 3.0, que estão contempladas no Banco de Nomes Geográficos do Brasil (BNGB)

https://servicodados.ibge.gov.br/api/v1/bngb/listacategoria

Responses

Status: 200 - Um array

Schema

Lista de Classes

Obtém uma lista de classes, de acordo com a EDGV 3.0, que estão contempladas no Banco de Nomes Geográficos do Brasil (BNGB).

https://servicodados.ibge.gov.br/api/v1/bngb/listaclasse

Responses

Status: 200 - Um array

Schema

Dicionário de termos da API em inglês, espanhol e português

Obtém traduções de termos da API para inglês, espanhol e descrições em português para uso como “labels” em portais

https://servicodados.ibge.gov.br/api/v1/bngb/dicionario

Responses

Status: 200 - Um array

Schema

Lista dos nomes geográficos

Obtém a lista dos nomes geográficos que constam no BNGB

https://servicodados.ibge.gov.br/api/v1/bngb/listanomegeo

Responses

Status: 200 - Um array

Schema

API do Banco de Nomes Geográficos do Brasil (BNGB)

API e documentação

Nome Geográfico

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos do BNGB em formato geojson

Nomes Geográficos por padrão

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por município

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por unidade da federação

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por proximidade

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por enquadramento

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por categoria

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Nomes Geográficos por classe

Parâmetros

Responses

Status: 200 - Um conjunto de nomes geográficos em formato geojson

Lista de categorias

Responses

Status: 200 - Um array

Lista de Classes

Responses

Status: 200 - Um array

Dicionário de termos da API em inglês, espanhol e português

Responses

Status: 200 - Um array

Lista dos nomes geográficos

Responses

Status: 200 - Um array

Notas de liberação