API address

Возможности:

  • Поиск и автозаполнение адреса или населённого пункта. Возможно как одной строкой, так и с заполнением населённого пункта и адреса в отдельных полях.
  • Прямое и обратное геокодирование. Для обратного геокодирования достаточно передать только параметры lon и lat.

Примеры:

Запрос

Формат запроса
https://api.geotree.ru/address.php?key=demo-wpAsbZLEPH28ZBg&параметр1=значение1&параметр2=значение2...

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

  • term - искомая строка
    term=красноярск ленина 11
    term=ленина красноярск

  • oktmo - код ОКТМО населённого пункта или муниципального образования, в котором будет выполнен будет выполнен поиск в первую очередь
    oktmo=50701&term=красный - поиск по городскому округу Новосибирск

  • lon,lat - координаты точки, относительно которой адреса, находящиеся в радиусе 1км, будут предоставлены в порядке увеличения расстояния до указанной точки, населенные пункты - в радиусе 100км
    lon=37.620353&lat=55.754032 - объекты, находящиеся рядом с Красной площадью (г Москва)
    lon=37.620353&lat=55.754032&term=Никольская - объекты по улице Никольская, в порядке увеличения расстояния от Красной площади

  • types - типы объектов, которые требуется найти, возможные значения
    "place" - населенные пункты
    "address" - адреса
    term=московская ленина&types=place - будет найден посёлок имени Ленина Московской области
    term=московская ленина&types=address - будут найдены адреса в посёлке имени Ленина Московской области

  • parent_fields - список параметров, которые будут предоставлены для населённого пункта и муниципальных образований, в которых расположены найденные адреса. См. параметр levels в разделе "Параметры ответа"
    term=ленина красноярск&parent_fields=name_display,oktmo_short - для населённого пункта и муниципальных образований, в которых расположены найденные адреса будут отображены только параметры name_display и oktmo_short

Параметры ответа

  • type - тип найденного объекта
    "place" - населенный пункт
    "address" - адрес

  • value - полное наименование объекта (может быть использовано при автозаполнении в плагине jQuery autocomplete)

  • description - описание объекта (может быть использовано при автозаполнении в плагине jQuery autocomplete)

  • address - адрес объекта

  • name - наименование здания (например, "Областной краеведческий музей")

  • geo_center - географический центр объекта (может находиться за пределами самого объекта)

  • geo_inside - точка расположенная внутри объекта

  • oktmo_short
    для адресов - код ОКТМО объекта в сокращенном виде, внутри которого находится найденный объект
    для населённых пунктов - код ОКТМО населённого пункта в сокращенном виде

  • oktmo_name - имя объекта, соответствующего коду oktmo_short

  • place_oktmo - код ОКТМО объекта в сокращенном виде, внутри которого находится найденный объект. Для адресов, расположенных в городах федерального значения указывается код самого города (без указания внутригородских территорий).

  • place_name - имя объекта, соответствующего коду place_oktmo

  • level - уровень кода ОКТМО. "4" - населённый пункт "3" - сельское или городское поселение "2" - территория города федерального значения, городской или муниципальный округ, или муниципальный район

  • levels
    для адресов - массив, содержащий вышестоящие муниципальные образования и населённый пункт, внутри которого расположен адрес
    для населённых пунктов - массив, содержащий вышестоящие муниципальные образования и найденный населённый пункт
    имеет индексы: 1, 2, 3, 4. Описание параметров элементов массива levels подробно описано в интерфейсе search