Geocode

Obtener una lista de ciudades por estado

Por el momento, esta función sólo está disponible en Brasil. Con la Geocode API puede obtener una lista de las ciudades del estado que desee. Para ello, deberá realizar una solicitud POST al siguiente punto final:

Donde el término {{state}} debe sustituirse por el acrónimo (UF) del estado deseado. Ejemplo: https://api.maplink.global/geocode/v1/geocode/states/SP/cities

La respuesta será la siguiente

{
    "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"
        }
    ]
}

Se devolverá la siguiente información:

  • found – Número de ciudades devueltas;
  • results – Matriz de objetos con resultados encontrados:
    • address – Objeto con información sobre la ciudad:
      • city – Nombre de la ciudad;
      • state – Objeto con datos relativos al estado:
        • code – Siglas del Estado (UF);
        • name – Nombre del Estado;
      • country – País;
      • capital – Valor booleano que indica si la ciudad es la capital del estado;
      • area – Superficie total de la ciudad, en metros cuadrados;
      • ibge – Objeto con códigos IBGE de ciudad y estado:
        • city – Código IBGE de la ciudad;
        • state – Código IBGE del Estado;
      • mainLocation – Objeto con coordenadas geográficas en latitud/longitud:
        • lat – Latitud en grados decimales;
        • lon – Longitud en grados decimales;
      • leftZipCode – Primer código postal de la ciudad;
      • rightZipCode – Último código postal de la ciudad;
    • type – Indica el mejor elemento encontrado en la base cartográfica para devolver la coordenada geográfica. En este caso siempre se devolverá como «CITY»;
    • score – Puntuación de referencia para el resultado del proceso de geocodificación;
    • label – Dirección completa encontrada utilizada en el proceso de geocodificación. En este caso, siempre se devolverá como «Ciudad, Estado, País».