Skip to content

Obter cidades

Request

Retorna cidades com base em critérios de pesquisa.

Formato de resposta: "Cidade - UF" (ex: "São Paulo - SP")

IMPORTANTE: O valor name retornado é o que deve ser enviado para prospecção.

Security
ApiKeyAuth
Query
namestring

Filtro por nome da cidade

Example:name=São Paulo
statestring

Filtro por estado (sigla UF)

Example:state=SP
curl -i -X GET \
  'https://docs.datastone.com.br/_mock/api/geo/city/?name=S%C3%A3o%20Paulo&state=SP' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cidades retornadas com sucesso

Bodyapplication/json
Array [
namestring

Nome da cidade no formato "Cidade - UF"

Example:"São Paulo - SP"
]
Response
[
  {
    "name": "São Paulo - SP"
  }
]