↑
Geocode

Multi Geocode API

O objetivo desse último endpoint é retornar as coordenadas geográficas a partir de múltiplos endereços, completos ou parciais.  

Para realizar a requisição para a Multi Geocode é necessário enviar a requisição usando o método POST para o seguinte endpoint: 

Lista de parâmetros

Parâmetros obrigatórios

  • id – Texto com o identificador do endereço buscado.

Aos parâmetros abaixos, é obrigatório informar ao menos um. Não é necessário informar todos. No entanto, quanto mais informações forem fornecidas, mais preciso será o resultado.

  • road – Nome da rua ou parte dele;
  • number – Número do logradouro. NÃO informar os dados do complemento.
  • city – Nome da cidade;
  • state – Estado;
  • country – País;
  • district – Nome do bairro;
  • zipcode – CEP.
  • label – Endereço completo. Recomenda-se montar o texto na ordem “Nome da rua, número, CEP, bairro, cidade, estado”.

Nota: Há o limite de 200 pontos para o envio em uma mesma requisição.

Parâmetros opcionais

  • mainLocation – Objeto com dois parâmetros para limitar a área de busca do endereço:
    • center – Objeto com as coordenadas de referência para a busca de resultados. As coordenadas podem ser informadas nos seguintes formatos:
      • Objeto com as propriedades lat e lon que representam latitude e longitude respectivamente. Exemplo: {"lat":-23.0852, "lon": -46.98020}
      • Array com latitude e longitude. Exemplo: [-23.0852,  -46.98020]
      • Coordenadas codificadas como geohash. Exemplo: "6tr6df675"
    • radius – Raio de busca, em metros, a partir do ponto central definido em center. Caso não seja informado, o valor padrão é 500.000 metros (500 Km).

Exemplo 1 – Buscar coordenadas de dois ou mais endereços na mesma requisição

Nesse exemplo vamos buscar dois endereços diferentes na mesma requisição. Para isso precisamos identificar cada um dos endereços com o parâmetro id.

O primeiro será "Address1" e o segundo "Address2". A requisição completa pode ser conferida abaixo:

[
    {
        "id": "Address1",
        "road": "Leopoldo Hess",
        "number": 75,
        "district": "São João",
        "zipcode": "88304-260",
        "city": "Itajai",
        "state": "SC"
    },
    {
        "id": "Address2",
        "road": "Alameda Campinas",
        "number": 579,
        "zipcode": "01419-001",
        "city": "São Paulo",
        "state": "SP"
    }
]

Resposta

A descrição de cada campo presente na resposta pode ser conferida no link a seguir: Estrutura de resposta – Geocode API.

A resposta completa encontra-se abaixo:

{
    "results": [
        {
            "id": "Address1",
            "address": {
                "road": "RUA LEOPOLDO HESS",
                "number": "75",
                "district": "SÃO JOÃO",
                "zipCode": "88304260",
                "city": "ITAJAÍ",
                "state": {
                    "name": "SANTA CATARINA",
                    "code": "SC"
                },
                "mainLocation": {
                    "lat": -26.903004,
                    "lon": -48.680296
                },
                "numberAsInteger": 75
            },
            "type": "ROAD",
            "label": "RUA LEOPOLDO HESS, 88304260, SÃO JOÃO, ITAJAÍ, SC",
            "score": 96.79654045442564,
            "precision": "NUMBER_EXACT"
        },
        {
            "id": "Address2",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404001",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56880844109,
                    "lon": -46.65604091167
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404001, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 96.91391938959099,
            "precision": "ROAD_CENTROID"
        }
    ],
    "found": 2
}