Автодополнение адресов

Подсказки для частичного ввода, оптимизированные по задержке и устойчивые к опечаткам. Каждая подсказка содержит координаты, поэтому большинству интеграций второй вызов не нужен вовсе.

Параметры

Пример

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

Поля ответа

Примечания

• Применяйте debounce к вводу примерно на 150 мс и отменяйте выполняющиеся запросы, если пользователь продолжает печатать. Ответы содержат query, на который они отвечают, поэтому устаревшие можно отбрасывать.
• Токенов сессии нет. Каждый вызов считается одним запросом. Обычно на выбор адреса уходит от 4 до 6 вызовов.
• Для публичных сайтов вызовы из браузера на бесплатном тарифе и есть предполагаемый способ использования. Учитывается IP посетителя, а не ваш.
• Форматы виджета Google places.Autocomplete, Mapbox Search Box, HERE Autosuggest и Bing Autosuggest доступны на совместимых хостах.

Тот же запрос в форматах других провайдеров

Если у вас уже есть код, написанный под одного из этих провайдеров, оставьте его: совместимый хост принимает тот же путь и те же параметры и отвечает в формате ответа этого провайдера, а за ним работает этот эндпоинт. См. как работают совместимые хосты.

Ошибки

400 invalid_request, если q короче 2 символов или types содержит неизвестное значение.