Adress-Autovervollständigung

Vorschläge für unvollständige Eingaben, optimiert auf Latenz und Tippfehlertoleranz. Jeder Vorschlag enthält Koordinaten, sodass die meisten Integrationen nie einen zweiten Aufruf brauchen.

Parameter

Beispiel

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

Antwortfelder

Hinweise

• Verzögern Sie die Eingabe (Debounce) um etwa 150 ms und brechen Sie laufende Anfragen ab, wenn der Nutzer weitertippt. Antworten enthalten die query, die sie beantworten, sodass Sie veraltete verwerfen können.
• Es gibt keine Sitzungstoken. Jeder Aufruf ist eine Anfrage. Die Auswahl einer typischen Adresse braucht 4 bis 6 Aufrufe.
• Aufrufe aus dem Browser im kostenlosen Kontingent sind für öffentliche Websites der vorgesehene Einsatz. Gezählt wird die IP des Besuchers, nicht Ihre.
• Die Formate des Google-Widgets places.Autocomplete, der Mapbox Search Box, von HERE Autosuggest und Bing Autosuggest sind auf den Drop-in-Hosts verfügbar.

Dieselbe Abfrage in den Formaten anderer Anbieter

Wenn Sie bereits Code für einen dieser Anbieter geschrieben haben, behalten Sie ihn: Der Drop-in-Host akzeptiert denselben Pfad und dieselben Parameter und antwortet in der Antwortstruktur dieses Anbieters, mit diesem Endpunkt dahinter. Siehe So funktionieren die Drop-in-Hosts.

Fehler

400 invalid_request, wenn q kürzer als 2 Zeichen ist oder types einen unbekannten Wert enthält.