Перейти к основному содержимому

Поиск мест интереса

Поиск интересных мест и достопримечательностей— это сервис, который позволяет осуществлять поиск мест интереса и дополнительной информации о них.

/places — точка вызова сервиса поиска мест интереса и получения дополнительной информации о них.

Запрос​

Обязательные параметры запроса​

Имя поляФорматОписаниеПример

api_key

hex-string

Доступ к сервисам.

api_key=fa749bace6d8a3b1....

q

string

Тело поискового запроса. В запросе можно использовать один из варинтов для поиска:

• координаты в формате lat,lon, где:

   • lat — широта искомой точки в градусах (используется 6 знаков после запятой);

   • lon — долгота искомой точки в градусах (используется 6 знаков после запятой);

• текстовая строка(может содержать имя искомого места интереса или адрес).

q=rustore.ru
q=метро
q=55.797041,37.537830

Дополнительные параметры запроса​

Имя поляФорматОписаниеПример

fields

fieldname1,fieldname2,....fieldnameN

Выбор полей, отображаемых в ответе.

Возможные значения:

• name (по умолчанию) — название места интереса;

• place_details — детальная информация о месте интереса (на текущий момент не поддерживается);

• address_details (по умолчанию) — детальная информация о найденном адресе с почтовым индексом без координат;

• address — адрес найденного места интереса одной строкой;

• pin (по умолчанию) — координаты найденного объекта (долгота и широта);

• bbox — область местонахождения объекта;

• geometry — границы объекта;

• type— тип объекта.

fields=pin,bbox,name

types

string

к сведению

На текущий момент не поддерживается.

Тип объектов, по которым осуществляется поиск.

По умолчанию поиск осуществляется по всем типам мест интересов.

Справочник постоянно актуализируется. Для получения полного и актуального справочника типов можно воспользоваться сервисом /v3/places/types.

types=hotel,metro

lang

2-х символьный код языка

Язык ответа на одном из доступных языков.

По умолчанию на языке региона в котором найден объект.

lang=en

location

string

Координата, относительно которой будет осуществляться поиск.

Координаты в формате lat,lon, где:

• lat— широта искомой точки в градусах (используется 6 знаков после запятой);

• lon— долгота искомой точки в градусах (используется 6 знаков после запятой).

предупреждение

Результаты поиска будут отсортированы по расстоянию от указанной координаты.

location=55.796743,37.537354

radius

integer

Радиус поиска в метрах относительно параметра location.

к сведению

Параметр location при использовании параметра radius является обязательным.

предупреждение

В случае использования малого радиуса объект может быть не найден.

radius=500

limit

integer

Ограничение числа объектов в ответе. Поддерживаются значения в интервале от 1 до 100.

По умолчанию: 5.

предупреждение

В случае использования больших значений, длительность получения ответа может увеличиться

limit=10

isocode

2char

Двухбуквенный код страны согласно ISO 3166-1 alpha-2

isocode=RU

Ответ​

Ответ предоставляется только в JSON-формате и содержит информацию найденную по запросу.

JSON-формат

Имя поляФорматОписаниеПример

request

string

Запрос

"request": "/v3/places?location=55.7967432,37.5373542&api_key=internal_&q=prime&fields=name,place_details,address,address_details,pin,bbox,geometry,type"

results

list

Найденный результат

"results": [
    {
      "address": "Россия, Москва, Северный административный округ, Москва, район Аэропорт, Ленинградский проспект, 72 к4",
      "address_details": {
        "building": "72 к4",
        "country": "Россия",
        "isocode": "RU",
        "locality": "Москва",
        "region": "Москва",
        "street": "Ленинградский проспект",
        "subregion": "Северный административный округ",
        "suburb": "район Аэропорт"
      },
      "bbox": null,
      "geometry": {
        "coordinates": [
          37.519963,
          55.805396
        ],
        "type": "Point"
      },
      "name": "Прайм",
      "pin": [
        37.519963,
        55.805396
      ],
      "type": "food/cafe"
    }
  ]
}

address

string

Полный адрес найденного объекта

"address": "Россия, Москва, Северный административный округ, Москва, Хорошёвский, Ленинградский проспект, 39 с14"

address_details

list

Детальная информация об адресе найденного объекта

"address_details": {
        "building": "39 с80",
        "country": "Россия",
        "isocode": "RU",
        "locality": "Москва",
        "postal_code": "125167",
        "region": "Москва",
        "street": "Ленинградский проспект",
        "subregion": "Северный административный округ",
        "suburb": "Хорошёвский"
}

pin

list

Координаты найденного объекта (долгота и широта)

"pin": [
        37.538851,
        55.796731
]

bbox

list

Границы местонахождения найденного объекта для позиционирования на карте

"bbox": [
        37.538253,
        55.796405,
        37.539368,
        55.79694
]

geometry

list

Геометрия найденного объекта объекта

"geometry": {
        "coordinates": [
          44.795525,
          41.775552
        ],
        "type": "Point"
}

name

string

Название найденного объекта

"name": "метро Аэропорт"

type

string

Тип найденного объекта.

"type": "public_transport/station_train"

Описание полей address_details

Имя поляФорматОписаниеПример

country

string

Страна

"country": "Россия"

isocode

2char

Двухбуквенный код страны согласно ISO 3166-1 alpha-2

"isocode": "RU"

region

string

Область

"region": "Москва"

subregion

string

Район

"subregion": "Северный административный округ"

locality

string

Населённый пункт

"locality": "Москва"

sublocality

string

Микрорайон или название жилого комплекса

"sublocality": "Аэропорт"

street

string

Улица

"street": "Проспект Ленинградский"

building

string

Номер дома, части дома или строения

"building": "39 с80"

suburb

string

Район/микрорайон населённого пункта

"suburb": "Хорошёвский"

postal_code

string

Почтовый код

"postal_code": "125167"

Описание полей geometry

Имя поляФорматОписаниеПример

type

string

Тип геометрии:

• Point— точка;

• MultiPoint— несколько точек;

• Linestring— линия;

• MultiLineString— несколько линий;

• Polygon— полигон;

• MultiPoligon— несколько полигонов.

"type": "Polygon"

coordinates

list

Массив точек (долгота и широта), описывающий геометрию объекта

"coordinates":  [
    [100.0, 0.0], [101.0, 0.0],
    [101.0, 1.0], [100.0, 1.0],
    [100.0, 0.0]
]

Пример​

https://geo.rustore.ru/api/places?api_key=<YOUR_API_KEY>&q=prime&fields=name,place_details,address,address_details,pin,bbox,geometry,type&location=55.7967432,37.5373542&limit=1 |