Поиск по почтовому индексу

На входе почтовый индекс, на выходе место, к которому он относится. Охватывает 160 стран.

GEThttps://api.mygeocode.com/v1/postcode

Параметры

Параметр	Тип	Описание
`code`обязательный	строка	Почтовый индекс. Пробелы, дефисы и регистр нормализуются.
`country`необязательный	строка	Код ISO 3166-1 alpha-2. Настоятельно рекомендуется: почтовые индексы не уникальны между странами. Без него возвращаются результаты из всех подходящих стран, начиная с самой населённой.
`lang`необязательный	строка	Код ISO 639-1 для названий мест и регионов. По умолчанию `en`.
`key`необязательный	строка	API-ключ, если он не передан в заголовке.

Пример

curlJavaScriptPython

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/postcode?code=75008&country=fr"

const url = new URL("https://api.mygeocode.com/v1/postcode");
url.searchParams.set("code", "75008");
url.searchParams.set("country", "fr");

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

import requests

r = requests.get("https://api.mygeocode.com/v1/postcode", params={"code": "75008", "country": "fr"}, headers={"X-API-Key": "YOUR_KEY"}, timeout=5)
first = r.json()["results"][0]
print(first["place"], first["lat"], first["lon"])

Ответ

{
  "status": "ok",
  "postcode": "75008",
  "country_code": "FR",
  "results": [
    {
      "postcode": "75008",
      "place": "Paris 8e Arrondissement",
      "region": "Ile-de-France",
      "region_code": "IDF",
      "country": "France",
      "country_code": "FR",
      "lat": 48.8727,
      "lon": 2.3125
    }
  ]
}

Поля ответа

Поле	Тип	Описание
`postcode`	строка	Индекс после нормализации.
`country_code`	строка или null	Применённый фильтр по стране, если есть.
`results`	массив	Места, которые охватывает индекс. Обычно одно; несколько для сельских индексов, охватывающих несколько деревень. Пусто, если индекс неизвестен.
`results[].place`	строка	Название населённого пункта, принятое почтовой службой.
`results[].region`, `region_code`	строка	Административная единица первого уровня и её суффикс ISO 3166-2.
`results[].lat`, `lon`	число	Точка почтовой службы, если она опубликована, иначе центроид адресов с этим индексом.

Примечания

Неполные индексы работают там, где система в стране иерархическая: SW1A для Великобритании возвращает район; 750 для Франции ничего не возвращает, потому что французские индексы не являются префиксами.
Страны без почтовых индексов (Ирландия до Eircode, ряд стран Африки и Ближнего Востока) возвращают пустой массив results со status: ok.
Для полного адреса с номером дома используйте прямое геокодирование; почтовый индекс помогает и ему.

Ошибки

400 invalid_request, если code пуст или длиннее 16 символов либо country не является корректным кодом alpha-2.