Возможны два варианта авторизации:
Ограничения устанавливаются для ключа: максимальное количество запросов в минуту, в день.
Для текстового поиска нужно отправить GET-запрос /textSearch.
URL: https://webmapapi.navitel.ru/api/v1/textSearch?s={s}&l={l}&lon={lon}&lat={lat}&ofs={ofs}&lim={lim}
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| s | Поисковый запрос, не менее 3-х символов | required | string | |
| l | Код языка, например: ru_RU | required | string | |
| lon | Координаты точки в пространстве, относительно близости к которой будут выдаваться наиболее релевантные результаты поиска, долгота | required | number | double |
| lat | Координаты точки в пространстве, относительно близости к которой будут выдаваться наиболее релевантные результаты поиска, широта | required | number | double |
| ofs | Порядковый номер элемента, с которого требуется начать выдавать результат поиска. Значение по умолчанию: 0 | optional | integer | |
| lim | Максимальное количество элементов в выданном результате поиска. Значение по умолчанию : 100 | optional | integer |
| Код ответа | Параметр | Тип данных | Описание |
| 200 | mapObjects | array [MapObject] – см. Типы данных для API Геосаджеста | Ответ на верный запрос в текстовом поиске: список объектов |
| 400 | Недопустимый аргумент | ||
| 401 | Ключ API отсутствует или недействителен | ||
| 403 | Истёк срок действия ключа API, превышены пределы поиска | ||
| 404 | Объект не найден |
Для адресного поиска нужно отправить GET-запрос/addressSearch.
URL: https://webmapapi.navitel.ru/api/v1/addressSearch?label={label}&country={country}®ion={region}&parish={parish}&city={city}&district={district}&street={street}&number={number}&zip={zip}&l={l}&lon={lon}&lat={lat}&ofs={ofs}&lim={lim}
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| label | Подпись к объекту на карте – поисковый запрос | optional | string | |
| country | Страна – поисковый запрос | optional | string | |
| region | Субъект федерации (например, область, край и пр.) – поисковый запрос | optional | string | |
| parish | Район (республики, автономного округа, области, края и пр.) – поисковый запрос | optional | string | |
| city | Город – поисковый запрос | optional | string | |
| district | Район (городской), населённый пункт, входящий в агломерацию – поисковый запрос | optional | string | |
| street | Улица – поисковый запрос | optional | string | |
| number | Номер здания, дома и пр. – поисковый запрос | optional | string | |
| zip | Почтовый индекс | optional | string | |
| l | Код языка, например: ru_RU | required | string | |
| lon | Координаты точки в пространстве, относительно близости к которой будут выдаваться наиболее релевантные результаты поиска, долгота | required | number | double |
| lat | Координаты точки в пространстве, относительно близости к которой будут выдаваться наиболее релевантные результаты поиска, широта | required | number | double |
| ofs | Порядковый номер элемента, с которого требуется начать выдавать результат поиска. Значение по умолчанию: 0 | optional | integer | |
| lim | Максимальное количество элементов в выданном результате поиска. Значение по умолчанию : 100 | optional | integer |
| Код ответа | Параметр | Тип данных | Описание |
| 200 | mapObjects | array [MapObject] – см. Типы данных для API Геосаджеста | Ответ на верный запрос в текстовом поиске: список объектов |
| 400 | Недопустимый аргумент | ||
| 401 | Ключ API отсутствует или недействителен | ||
| 403 | Истёк срок действия ключа API, превышены пределы поиска | ||
| 404 | Объект не найден |
Для поиска ближайших объектов нужно отправить GET-запрос/findNearest.
URL: https://webmapapi.navitel.ru/api/v1/findNearest?lon={lon}&lat={lat}&l={l}
Параметры запроса (FindNearestRequest)
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| lon | Координаты точки в пространстве, относительно которой происходит поиск ближайших объектов, долгота | required | number | double |
| lat | Координаты точки в пространстве, относительно которой происходит поиск ближайших объектов, широта | required | number | double |
| l | Код языка, например: ru_RU | required | string |
| Код ответа | Параметр | Тип данных | Описание |
| 200 | mapObjects | array [MapObject] – см. Типы данных для API Геосаджеста | Ответ на верный запрос в текстовом поиске: ближайший объект |
| 400 | Недопустимый аргумент | ||
| 401 | Ключ API отсутствует или недействителен | ||
| 403 | Истёк срок действия ключа API, превышены пределы поиска | ||
| 404 | Объект не найден |
MapObject – объект на карте
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| coordinates | Объект на карте | optional | array [Coordinates] | |
| address | Адреса объектов на карте | optional | array [Address] | |
| label | Подпись объекта на карте | optional | string |
Сoordinates – координаты точки
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| longitude | Долгота | required | number | double |
| latitude | Широта | required | number | double |
Address – адреса
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| country | Страна | optional | string | |
| region | Субъект федерации (например, область, край и пр.) | optional | string | |
| parish | Район (республики, автономного округа, области, края и пр.) | optional | string | |
| city | Город | optional | string | |
| district | Район (городской), населённый пункт, входящий в агломерацию | optional | string | |
| street | Улица | optional | string | |
| building | Здание, дом | optional | string |
Запрос GET/textSearch
https://webmapapi.navitel.ru/api/v1/textSearch?s=Театр&l=ru_RU&lon=37.607465&lat=55.752532&ofs=0&lim=3&t=YOUR_API_KEY
Ответ на запрос GET/textSearch
Запрос GET/addressSearch
https://webmapapi.navitel.ru/api/v1/addressSearch?label=гостиница&street=Поварская&l=ru_RU&lon=37.622413&lat=55.772318&ofs=3&lim=2&t=YOUR_API_KEY
Ответ на запрос GET/addressSearch
Запрос GET /findNearest
https://webmapapi.navitel.ru/api/v1/findNearest?lon=37.464038&lat=55.808733&l=ru_RU&t=YOUR_API_KEY
Ответ на запрос GET /findNearest
There are two possible authorization options:
Limits are set for the key: the maximum number of requests per minute, per day.
For text search, you need to send a GET request /textSearch.
URL: https://webmapapi.navitel.ru/api/v1/textSearch?s={s}&l={l}&lon={lon}&lat={lat}&ofs={ofs}&lim={lim}
| Parameter | Description | Required/ Optional | Data type | Data Format |
| s | Search pattern – a search query of at least 3 characters | required | string | |
| l | Language code, for example: ru_RU | required | string | |
| lon | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, longitude | required | number | double |
| lat | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, latitude | required | number | double |
| ofs | The ordinal number of the element from which you want to start producing the search result. Default value: 0 | optional | integer | |
| lim | The maximum number of items in the returned search result. Default value: 100 | optional | integer |
| Response Code | Parameter | Data type | Description |
| 200 | mapObjects | Array [MapObject] — please refer to the Data Types below | Answer to the correct text search query: list of objects |
| 400 | Invalid argument | ||
| 401 | The API key is missing or invalid | ||
| 403 | API key has expired, search limits exceeded | ||
| 404 | Object not found |
To perform an address search, you need to send a GET request /addressSearch.
URL: https://webmapapi.navitel.ru/api/v1/addressSearch?label={label}&country={country}®ion={region}&parish={parish}&city={city}&district={district}&street={street}&number={number}&zip={zip}&l={l}&lon={lon}&lat={lat}&ofs={ofs}&lim={lim}
| Parameter | Description | Required/ Optional | Data type | Data Format |
| label | The caption for the object on the map – request pattern (search request) | optional | string | |
| country | Country – request pattern (search request) | optional | string | |
| region | A federal subject (for example, a region, a region, etc.) – request pattern (search request) | optional | string | |
| parish | District (republic, autonomous okrug, region, territory, etc.) – request pattern (search request) | optional | string | |
| city | City – request pattern (search request) | optional | string | |
| district | District (urban), settlement included in the agglomeration - request pattern (search request) | optional | string | |
| street | Street – request pattern (search request) | optional | string | |
| number | Number of the building, house, etc. – request pattern (search request) | optional | string | |
| zip | Postcode | optional | string | |
| l | Language code, for example: ru_RU | required | string | |
| lon | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, longitude | required | number | double |
| lat | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, latitude | required | number | double |
| ofs | The ordinal number of the element from which you want to start producing the search result. Default value: 0 | optional | integer | |
| lim | The maximum number of items in the returned search result. Default value: 100 | optional | integer |
| Response Code | Parameter | Data type | Description |
| 200 | mapObjects | Array [MapObject] — please refer to Data types for GeoSuggest API | Answer to the correct text search query: list of objects |
| 400 | Invalid argument | ||
| 401 | The API key is missing or invalid | ||
| 403 | API key has expired, search limits exceeded | ||
| 404 | Object not found |
To search for nearby objects, you need to send a GET request /findNearest.
URL: https://webmapapi.navitel.ru/api/v1/findNearest?lon={lon}&lat={lat}&l={l}
| Parameter | Description | Required/ Optional | Data type | Data Format |
| lon | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, longitude | required | number | double |
| lat | Coordinates of the point in space, relative to the proximity to which the most relevant search results will be displayed, latitude | required | number | double |
| l | Language code, such as: ru_RU | required | string |
| Response Code | Parameter | Data type | Description |
| 200 | mapObjects | object {MapObject} – please refer to the Data Types below | The response to the correct request in a text search is: the nearest object |
| 400 | Invalid argument | ||
| 401 | The API key is either missing or not valid | ||
| 403 | The API key has expired; the search limits have been exceeded | ||
| 404 | Object not found |
MapObject – object on the map
| Parameter | Description | Required/ Optional | Data type | Data Format |
| coordinates | Object on the map | optional | array [Coordinates] | |
| address | Addresses of objects on the map | optional | array [Address] | |
| label | Caption of the object on the map | optional | string |
Сoordinates – point coordinates
| Parameter | Description | Required/ Optional | Data type | Data Format |
| longitude | Longitude | required | number | double |
| latitude | Latitude | required | number | double |
Address – address of the object on the map
| Parameter | Description | Required/ Optional | Data type | Data Format |
| country | Country | optional | string | |
| region | Subject of the Federation (e.g., region, province, etc.) | optional | string | |
| parish | District (of a Republic, Autonomous District, Region, Territory, etc.) | optional | string | |
| city | City | optional | string | |
| district | Urban District or Settlement within an Agglomeration | optional | string | |
| street | Street | optional | string | |
| building | Building, house | optional | string |
Request GET /textSearch
https://webmapapi.navitel.ru/api/v1/textSearch?s=Teatr&l=en_US&lon=37.607465&lat=55.752532&ofs=0&lim=2&t= YOUR_API_KEY
Response to the request GET /textSearch
Request GET /addressSearch
https://webmapapi.navitel.ru/api/v1/addressSearch?label=hotel&street=Povarskaya&l=en_EN&lon=37.622413&lat=55.772318&ofs=1&lim=2&t=YOUR_API_KEY
Response to the request GET /addressSearch
Request GET /findNearest
https://webmapapi.navitel.ru/api/v1/findNearest?lon=37.464038&lat=55.808733&l=en_EN&t=YOUR_API_KEY
Response to the request GET /findNearest