Cities and neighborhoods

The location catalog: city by its IBGE code and neighborhood by its catalog identifier. Neighborhoods are closed against the catalog — that is what lets a property into recommendations.

GET/v1/geo/cities— Cities
GET/v1/geo/cities/{cityId}/neighborhoods— A city's neighborhoods

Routes

GET/v1/geo/cities

Cities

Catalog cities, with their IBGE code.

Permission: any valid key

Query parameters

ufstring: Only one state (2 letters).
qstring: Part of the name (accents ignored).
limitinteger: Items per page: 1 to 1000 (default 100).
cursorstring: The nextCursor from the previous page. The list is over when it comes back null. It is only valid for this route and this account.

Response200OK

datalist of Cityrequired: The cities.
nextCursorstringrequirednullable: Next page.
totalintegerrequired: Total in the filter.

Example

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

Errors for this route

400invalid_param

And the errors common to every route

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

A city's neighborhoods

Catalog neighborhoods. The neighborhoodSlug from here is what guarantees the property enters recommendations.

Permission: any valid key

Path parameters

cityIdstringrequired: IBGE code (7 digits).

Query parameters

limitinteger: Items per page: 1 to 1000 (default 100).
cursorstring: The nextCursor from the previous page. The list is over when it comes back null. It is only valid for this route and this account.

Response200OK

datalist of Neighborhoodrequired: The neighborhoods.
nextCursorstringrequirednullable: Next page.
totalintegerrequired: Total.

Example

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

Errors for this route

And the errors common to every route

Objects

City

A catalog city.

cityIdstringrequired: IBGE code, 7 digits — the safest way to send the city.
namestringrequired: City name.
ufstringrequired: State (UF).
citySlugstringrequired: City identifier in the catalog.

Neighborhood

A catalog neighborhood.

neighborhoodSlugstringrequired: The neighborhood identifier — the neighborhoodSlug value for writes.
namestringrequired: Neighborhood name.