Прямое геокодирование

Превращает текст в координаты. Принимает полные адреса, неполные адреса, почтовые индексы, названия мест и точки интереса на любом языке.

Параметры

Пример

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/forward?q=Dam+1,+Amsterdam&countries=nl&limit=1"

const url = new URL("https://api.mygeocode.com/v1/forward");
url.searchParams.set("q", "Dam 1, Amsterdam");
url.searchParams.set("countries", "nl");
url.searchParams.set("limit", "1");

const data = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(data.results[0]);

import requests

r = requests.get("https://api.mygeocode.com/v1/forward",
                 params={"q": "Dam 1, Amsterdam", "countries": "nl", "limit": 1}, headers={"X-API-Key": "YOUR_KEY"}, timeout=10)
print(r.json()["results"][0])

{
  "status": "ok",
  "query": "Dam 1, Amsterdam",
  "results": [
    {
      "formatted": "Dam 1, 1012 JS Amsterdam, Netherlands",
      "lat": 52.373119,
      "lon": 4.893604,
      "type": "address",
      "precision": "house",
      "confidence": 0.98,
      "place_id": "nl.addr.c21d40e8",
      "components": {
        "house_number": "1",
        "road": "Dam",
        "neighbourhood": "Centrum",
        "city": "Amsterdam",
        "state": "North Holland",
        "state_code": "NH",
        "postcode": "1012 JS",
        "country": "Netherlands",
        "country_code": "nl"
      },
      "bounds": { "north": 52.373519, "south": 52.372719, "east": 4.894204, "west": 4.893004 }
    }
  ]
}

Поля ответа

Ключи компонентов

Присутствуют только применимые ключи. Во всех странах используются одни и те же ключи.

Примечания

• Результаты упорядочены по сочетанию достоверности, точности и близости. Используйте первый результат, если только вы не показываете список для выбора.
• Если номер дома не найден на известной улице, результат имеет type: street и precision: street, а номер интерполируется там, где позволяют данные. Проверяйте precision, если это для вас важно.
• Одни почтовые индексы в q тоже подходят. Для задач, где нужны только индексы, эндпоинт почтовых индексов работает быстрее и возвращает название места, принятое почтовой службой.
• Запрос в одной письменности для места, где используется другая (например, кириллицей для японского адреса), работает, но письменность ответа определяет lang.

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

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

Пакетные запросы

Отправьте POST-запрос с телом JSON на тот же путь с queries, массивом до 100 адресов, и ответ будет содержать массив results с одной записью на каждый запрос в порядке отправки. Каждая запись засчитывается как один запрос, а пакет, превышающий остаток квоты, отклоняется целиком.

$ curl -X POST "https://api.mygeocode.com/v1/forward" -H "Content-Type: application/json" -d '{"queries": ["Brandenburg Gate, Berlin", "Bahnhofstrasse 1, Zurich"]}'

Ошибки

400 invalid_request, если нет ни q, ни структурированного поля, ни place_id, если limit вне диапазона от 1 до 10 или если bounds или proximity имеет неверный формат. Остальное см. в разделе ошибки.