Cidades e bairros

O catálogo de localização: cidade pelo código do IBGE e bairro pelo identificador do catálogo. Bairro é fechado contra o catálogo — é por ele que o imóvel entra nas recomendações.

GET/v1/geo/cities— Cidades
GET/v1/geo/cities/{cityId}/neighborhoods— Bairros de uma cidade

As rotas

GET/v1/geo/cities

Cidades

As cidades do catálogo, com o código do IBGE.

Permissão: qualquer chave válida

Filtros e paginação

ufstring: Só as de um estado (2 letras).
qstring: Parte do nome (sem acento conta igual).
limitinteger: Itens por página: de 1 a 1000 (padrão 100).
cursorstring: O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.

Resposta200OK

datalista de Cityobrigatório: As cidades.
nextCursorstringobrigatóriopode vir nulo: Próxima página.
totalintegerobrigatório: Total no filtro.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/geo/cities' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

400invalid_param

E os erros comuns a toda rota

GET/v1/geo/cities/{cityId}/neighborhoods

Bairros de uma cidade

Os bairros do catálogo. O neighborhoodSlug daqui é o que garante que o imóvel entra nas recomendações.

Permissão: qualquer chave válida

Parâmetros no caminho

cityIdstringobrigatório: Código do IBGE (7 dígitos).

Filtros e paginação

limitinteger: Itens por página: de 1 a 1000 (padrão 100).
cursorstring: O nextCursor da página anterior. A lista acabou quando ele vem nulo. Ele vale só para esta rota e esta conta.

Resposta200OK

datalista de Neighborhoodobrigatório: Os bairros.
nextCursorstringobrigatóriopode vir nulo: Próxima página.
totalintegerobrigatório: Total.

Exemplo

curl -X GET 'https://api.imobyflow.com.br/v1/geo/cities/4106902/neighborhoods' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Erros desta rota

E os erros comuns a toda rota

Os objetos

City

Uma cidade do catálogo.

cityIdstringobrigatório: Código do IBGE, 7 dígitos — a forma mais segura de mandar a cidade.
namestringobrigatório: Nome da cidade.
ufstringobrigatório: Estado (UF).
citySlugstringobrigatório: Identificador da cidade no catálogo.

Neighborhood

Um bairro do catálogo.

neighborhoodSlugstringobrigatório: O identificador do bairro — o valor de neighborhoodSlug na escrita.
namestringobrigatório: Nome do bairro.