Preenchimento automático de endereços

Sugestões para entradas parciais, otimizadas para baixa latência e tolerância a erros de digitação. Cada sugestão traz coordenadas, então a maioria das integrações nunca precisa de uma segunda chamada.

Parâmetros

Exemplo

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/autocomplete?q=oxford+st&proximity=51.515,-0.141&limit=3"

const url = new URL("https://api.mygeocode.com/v1/autocomplete");
url.searchParams.set("q", "oxford st");
url.searchParams.set("proximity", "51.515,-0.141");
url.searchParams.set("limit", "3");

const { suggestions } = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
suggestions.forEach((s) => console.log(s.text, s.lat, s.lon));

import requests

r = requests.get("https://api.mygeocode.com/v1/autocomplete",
                 params={"q": "oxford st", "proximity": "51.515,-0.141", "limit": 3}, headers={"X-API-Key": "YOUR_KEY"}, timeout=5)
for s in r.json()["suggestions"]:
    print(s["text"], s["lat"], s["lon"])

{
  "status": "ok",
  "query": "oxford st",
  "suggestions": [
    { "text": "Oxford Street, London W1, United Kingdom", "lat": 51.515419, "lon": -0.141588, "type": "street", "precision": "street", "place_id": "gb.street.0a91e2c4" },
    { "text": "Oxford Street, Southampton SO14, United Kingdom", "lat": 50.899021, "lon": -1.399537, "type": "street", "precision": "street", "place_id": "gb.street.77b4d1f0" },
    { "text": "Oxford Street Station, London W1, United Kingdom", "lat": 51.515167, "lon": -0.141251, "type": "poi", "precision": "house", "place_id": "gb.poi.3c5a8e19" }
  ]
}

Campos da resposta

Observações

• Aplique debounce na entrada de cerca de 150 ms e cancele as requisições em andamento quando o usuário continuar digitando. As respostas trazem a query que respondem, para que você possa descartar as desatualizadas.
• Não há tokens de sessão. Cada chamada é uma requisição. Escolher um endereço típico leva de 4 a 6 chamadas.
• Chamar a partir do navegador no nível gratuito é o uso previsto para sites públicos. O IP do visitante é contado, não o seu.
• Os formatos do widget places.Autocomplete do Google, do Mapbox Search Box, do HERE Autosuggest e do Bing Autosuggest estão disponíveis nos hosts compatíveis (drop-in).

A mesma consulta nos formatos de outros provedores

Se você já tem código escrito para um desses provedores, mantenha-o: o host compatível aceita o mesmo caminho e os mesmos parâmetros e responde no formato de resposta desse provedor, com este endpoint por trás. Veja como funcionam os hosts compatíveis.

Erros

400 invalid_request quando q tem menos de 2 caracteres, ou quando types contém um valor desconhecido.