Geocode

Reverse Geocode API

El objetivo de este segundo endpoint, Reverse Geocode, es devolver información sobre la dirección a partir de sus coordenadas.

Para realizar la solicitud a Reverse Geocode es necesario enviar la solicitud utilizando el método POST al siguiente endpoint:

Para direcciones fuera de Brasil, tendrá que añadir el query param globalSearch en la URL, como sigue: https://api.maplink.global/geocode/v1/reverse?globalSearch=true

Lista de parámetros

Parámetros obligatorios

  • lat – Latitud;
  • lon – Longitud.

Parámetros opcionales

  • id – Texto con el identificador de la dirección buscada;
  • distance – Distancia máxima en metros para la búsqueda de direcciones.

Nota: Hay un límite de 200 puntos por enviar la misma solicitud.

Ejemplo 1 – Búsqueda de la dirección a partir de la coordenada

[
    {
        "lat": -23.566617861455924, 
        "lon": -46.65362331449377
    }
]

En la respuesta, se devuelve la siguiente información:

  • found – Número de registros devueltos.
  • results – Array de objetos con todos los resultados encontrados:
    • id – Identificador de la dirección introducida en la solicitud;
    • address – Objeto con información sobre la dirección:
      • road – Nombre de la ruta;
      • district – Barrio;
      • zipCode – Código postal;
      • city – Ciudad;
      • state – Estado;
      • mainLocation – Coordenadas geográficas en latitude/longitude;
    • type – Indica el mejor elemento encontrado en la base cartográfica para devolver la coordenada geográfica;
    • score – Puntuación de referencia para el resultado del proceso de geocodificación;
    • distance – Distancia en metros desde la coordenada enviada..;
    • label – Dirección completa encontrada utilizada en el proceso de geocodificación.

Nota: Cuanto más alto sea el score mayor será la relevancia del resultado para la dirección solicitada.

A continuación encontrará la respuesta completa:

{
    "found": 1,
    "results": [
        {
            "id": "1034bf0c-8d7a-474c-8eb1-6a0108882054",
            "address": {
                "road": "Alameda Campinas",
                "district": "Jardim Paulista",
                "zipCode": "01404000",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.5665,
                    "lon": -46.65382
                }
            },
            "type": "ZIPCODE",
            "score": 9976.046,
            "distance": 23.95446729752212,
            "label": "Alameda Campinas, Jardim Paulista, 01404000, São Paulo, São Paulo, SP"
        }
    ]
}

Ejemplo 2 – Búsqueda de una dirección a partir de más de una coordenada

En este ejemplo, buscaremos resultados para dos coordenadas diferentes. Para ello, debemos identificarlos con el parámetro id. El primer punto será "L1" y el segundo "L2".

El punto "L1" debe arrojar resultados en un radio de 25 metros. Para ello utilizamos el parámetro distance.

La solicitud completa figura a continuación:

{
    "found": 2,
    "results": [
        {
            "id": "L1",
            "address": {
                "road": "Rua Leopoldo Hess",
                "district": "São João",
                "zipCode": "88304260",
                "city": "Itajaí",
                "state": {
                    "code": "SC",
                    "name": "Santa Catarina"
                },
                "mainLocation": {
                    "lat": -26.90309606687984,
                    "lon": -48.68019337952068
                },
                "geometry": [
                    {
                        "lat": -26.90371956910269,
                        "lon": -48.6800353812277
                    },
                    {
                        "lat": -26.90247256465699,
                        "lon": -48.68035137781368
                    }
                ],
                "leftZipCode": "88304260",
                "rightZipCode": "88304260",
                "leftFirstNumber": 2,
                "leftLastNumber": 244,
                "rightFirstNumber": 1,
                "rightLastNumber": 161
            },
            "type": "ROAD",
            "score": 9994.67,
            "distance": 5.329992775797795,
            "label": "Rua Leopoldo Hess, São João, 88304260, Itajaí, Santa Catarina, SC"
        },
        {
            "id": "L2",
            "address": {
                "road": "Avenida Gov. Adolfo Konder",
                "district": "Cidade Nova",
                "zipCode": "88308001",
                "city": "Itajaí",
                "state": {
                    "code": "SC",
                    "name": "Santa Catarina"
                },
                "mainLocation": {
                    "lat": -26.908718086920004,
                    "lon": -48.67877389320046
                },
                "geometry": [
                    {
                        "lat": -26.908539588131305,
                        "lon": -48.67824538861362
                    },
                    {
                        "lat": -26.908896585708703,
                        "lon": -48.679302397787296
                    }
                ],
                "leftZipCode": "88308001",
                "rightZipCode": "88308000",
                "leftFirstNumber": 231,
                "leftLastNumber": 531,
                "rightFirstNumber": 232,
                "rightLastNumber": 532
            },
            "type": "ROAD",
            "score": 9969.358,
            "distance": 30.641980035785615,
            "label": "Avenida Gov. Adolfo Konder, Cidade Nova, 88308001, Itajaí, Santa Catarina, SC"
        }
    ]
}