Geocode

Obter a lista de cidades por estado

Com a Geocode API é possível obter a lista das cidades do estado desejado. Para isso será necessário realizar uma requisição do tipo POST para o seguinte endpoint:

Onde o termo {{state}} deverá ser substituído pela sigla (UF) do estado desejado. Exemplo: https://api.maplink.global/geocode/v1/geocode/states/SP/cities

A resposta será retornada da seguinte forma:

{
    "found": 645,
    "results": [
        {
            "address": {
                "city": "AGUAÍ",
                "state": {
                    "code": "SP",
                    "name": "SÃO PAULO"
                },
                "country": "BRASIL",
                "capital": false,
                "area": 474.695,
                "ibge": {
                    "city": "3500303",
                    "state": "35"
                },
                "mainLocation": {
                    "lat": -22.0589929,
                    "lon": -46.9822351
                },
                "leftZipCode": "13860001",
                "rightZipCode": "13869999"
            },
            "type": "CITY",
            "score": 52.155304,
            "label": "AGUAÍ, SP, BRASIL"
        }
    ]
}

As seguintes informações serão retornadas:

  • found – Quantidade de cidades retornados;
  • results – Array de objetos com resultados encontrados:
    • address – Objeto com informações da cidade:
      • city – Nome da cidade;
      • state – Objeto com dados referentes ao estado:
        • code – Sigla (UF) do estado;
        • name – Nome do estado;
      • country – País;
      • capital – Valor booleano que indica se a cidade é a capital do estado;
      • area – Área total da cidade, em metros quadrados;
      • ibge – Objeto com os códigos IBGE da cidade e do estado:
        • city – Código IBGE da cidade;
        • state – Código IBGE do estado;
      • mainLocation – Objeto com as coordenadas geográficas em latitude/longitude:
        • lat – Latitude em graus decimais;
        • lon – Longitude em graus decimais;
      • leftZipCode – Primeiro código postal da faixa de códigos postais da cidade; 
      • rightZipCode – Último código postal da faixa de códigos postais da cidade; 
    • type – Indica qual o melhor elemento encontrado na base cartográfica para o retorno da coordenada geográfica. Nesse caso será retornado sempre como “CITY”;
    • score – Pontuação de referência do resultado do processo de geocodificação;
    • label – Endereço completo encontrado utilizado no processo de geocodificação. Nesse caso, será retornado sempre como “Cidade, Estado, País”.