Skip to content

Obter bairros

Request

Retorna bairros com base em critérios de pesquisa.

Formato de resposta: "Bairro - Cidade - UF"

Security
ApiKeyAuth
Query
namestring

Filtro por nome do bairro

citystring

Filtro por cidade

statestring

Filtro por estado (sigla UF)

curl -i -X GET \
  'https://docs.datastone.com.br/_mock/api/geo/neighborhood/?name=string&city=string&state=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bairros retornados com sucesso

Bodyapplication/json
Array [
namestring

Nome no formato "Bairro - Cidade - UF"

Example:"Distrito de Roselândia - Bela Vista de Goiás - GO"
]
Response
[
  {
    "name": "Distrito de Roselândia - Bela Vista de Goiás - GO"
  }
]