Address autocomplete

Suggestions for partial input, tuned for latency and typo tolerance. Every suggestion carries coordinates, so most integrations never need a second call.

Parameters

Example

$ curl "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)).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}, 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" }
  ]
}

Response fields

Notes

• Debounce input to around 150 ms and cancel in-flight requests when the user keeps typing. Responses carry the query they answer, so you can discard stale ones.
• There are no session tokens. Each call is one request. A typical address takes 4 to 6 calls to pick.
• Calling from the browser on the free tier is the intended use for public sites. The visitor's IP is counted, not yours.
• The Google places.Autocomplete widget, Mapbox Search Box, HERE Autosuggest and Bing Autosuggest formats are available on the drop-in hosts.

The same lookup in other providers' formats

If you already have code written against one of these providers, keep it: the drop-in host accepts the same path and parameters and answers in that provider's response shape, with this endpoint behind it. See how the drop-ins work.

Errors

400 invalid_request when q is shorter than 2 characters, or types contains an unknown value.