Для авторизации ключ API указывается в качестве значения параметра Api-Key заголовка запроса.
Ограничения устанавливаются для ключа: максимальное количество запросов в минуту, в день.
Сервисы TSP API, DistanceMatrixAPI, IsochronesAP пока доступны только для карты Российской Федерации.
Для создания задачи на построение изохрон нужно отправить POST-запрос /calculateIsochrones.
URL: https://webmapapi.navitel.ru/api/v1/calculateIsochrones/
Координаты точек маршрута и другие параметры передаются в виде JSON в теле запроса.
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| durations | Массив временных периодов для вычисления изохронных контуров (в секундах) | required | array [integer] | int32 |
| center_pt | Центральная точка изохроны | required | object {Coordinates} | |
| start_time | Время для использования вместо текущей даты и времени. Если не задано, будет использоваться текущее время | optional | string example: 2025-02-28T15:30:00Z | date-time |
| reverse | Если данный параметр указан, то изохроны строятся к указанной точке, а не от нее. Значение по умолчанию: false | optional | boolean | |
| simplify | Если задан этот параметр («упростить»), контур изохрон будет генерализован. Значение по умолчанию: false | optional | boolean | |
| vehicle_type | Виды используемых транспортных средств. Возможные варианты: • bicycle – велосипед, • pedestrian – пешеход, • automobile – автомобиль. Значение по умолчанию: automobile | optional | string enum: [bicycle, pedestrian, automobile] | |
| jams | Учитывать ли при построении маршрута информацию о текущих дорожных пробках. Значение по умолчанию: false | optional | boolean | |
| optimization | Тип оптимизации маршрута: • по времени: fastest – самый быстрый; • по расстоянию: shortest – кратчайший. Значение по умолчанию: false | optional | string enum: [fastest, shortest] |
| Код ответа | Параметр | Тип данных | Описание |
| 200 | contours | array [IsochroneContour] – см. Типы данных для Isochrone API | Массив контуров изохрон |
| 200 | calculation_time | object {Duration} – см. Типы данных для Isochrone API | Расчётное время |
| 200 | road_lookup_time | object {Duration} – см. Типы данных для Isochrone API | Время поиска ближайшей дороги к точкам изохрон |
| 200 | generalize_time | object {Duration} – см. Типы данных для Isochrone API | Время до точек изохрон обобщенного контура |
| 400 | code | string enum: [bad_points, no_route, too_many_points, invalid_time] | Неверный запрос. Возможные варианты code: • bad_points – точки находятся за пределами карты, • no_route – маршрут не может быть построен, • too_many_points – количество точек превышает допустимое значение, • invalid_time – неверное время отправления |
| 400 | message | string | Неверный запрос. Возможные варианты code: • bad_points – точки находятся за пределами карты, • no_route – маршрут не может быть построен, • too_many_points – количество точек превышает допустимое значение, • invalid_time – неверное время отправления |
| 401 | Ключ API отсутствует или недействителен | ||
| 403 | Истёк срок действия ключа API, превышены пределы поиска | ||
| 500 | Внутренняя ошибка сервера |
Сoordinates – координаты точки
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| longitude | Долгота | required | number | double |
| latitude | Широта | required | number | double |
Duration – продолжительность временных параметров изохрон
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| ms | Продолжительность временного параметра, в миллисекундах | optional | integer | Int32 |
IsochroneContour – изохронный контур
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| geometry | Геометрия | optional | array [Coordinates] | |
| center_pt | Центральная точка изохроны по запросу | optional | object {Coordinates} | |
| center_road_pt | Ближайшая к центральной точке точка дороги, в которой производится расчёт | optional | object {Coordinates} | |
| duration_sec | Значения времени для вычисления изохронных контуров, в секундах | optional | integer | int32 |
| status | Статус расчёта изохронного контура | optional | object {Isochron-eContourStatus} |
IsochroneContourStatus – статус изохронного контура
| Параметр | Описание | Обязательно/ Опционально | Тип данных | Формат данных |
| code | Код. Возможные варианты code: • contour_ok – расчёт изохроны успешно завершён; • contour_empty – контур изохроны пуст; • contour_fail – при расчёте контура изохроны произошла неизвестная ошибка; • lookup_fail – точка находится более чем в 10 км от дорог, обозначенных на дорожной карте | optional | string enum: [contour_ok, con-tour_empty, con-tour_fail, lookup_fail] | |
| message | Сообщение | optional | string |
Запрос
Тело ответа:
The service allows you to get an area on the map that is reachable within a specified time when moving from the point of departure on foot, by bicycle or by car.
Isochrones are lines on a map showing points with the same time to reach from a given location.
For authorization, the API key is specified as the value of the Api-Key parameter of the request header.
Limits are set for the key: the maximum number of requests per minute, per day.
TSP API, DistanceMatrixAPI, IsochronesAP services are currently available only for the Russian Federation.
To create a task for constructing isochrones, you need to send a POST request /calculateIsochrones.
URL: https://webmapapi.navitel.ru/api/v1/calculateIsochrones/
Waypoint coordinates and other parameters are sent as JSON in the body of the request.
| Parameter | Description | Required/ Optional | Data type |
|---|---|---|---|
| durations | An array of time periods for calculating isochronous contours, in seconds | required | array [integer] |
| center_pt | The central point of the isochron | required | object {Coordinates} |
| start_time | The time to use instead of the current date and time. If not specified, the current time will be used | optional | string example: 2025-02-28T15:30:00Z |
| reverse | If this parameter is specified, isochrons are plotted to the specified point, not from it. Default value: false | optional | boolean |
| simplify | If this parameter is set ("simplify"), the contour of the isochron will be generalized. Default value: false | optional | boolean |
| vehicle_type | Types of vehicles used. Possible options:
| optional | string enum: [bicycle, pedestrian, automobile] |
| jams | To take into account or not when planning a route information about current traffic jams. Default value: false | optional | boolean |
| optimization | Type of route optimization:
| optional | string enum: [fastest, shortest] |
| Response Code | Parameter | Data type | Description |
| 200 | contours | array [IsochroneContour] — see Data types for Isochrone API | The array of isochron contours |
| 200 | calculation_time | object {Duration} — see Data types for Isochrone API | Estimated time |
| 200 | road_lookup_time | object {Duration} — please refer to the Data types for Isochrone API | The time to search for the nearest road to the isochron points |
| 200 | generalize_time | object {Duration} — see Data types for Isochrone API | The time to the isochronous points of the generalized contour |
| 400 | code | string enum: [bad_points, no_route, too_many_points, inva-lid_time] | Invalid request. Possible code options: • bad_points – points are outside the map, • no_route – the route cannot be built, • too_many_points – the number of points exceeds the allowed value, • invalid_time – incorrect departure time |
| 400 | message | string | Invalid request. Possible code options: • bad_points – points are outside the map, • no_route – the route cannot be built, • too_many_points – the number of points exceeds the allowed value, • invalid_time – incorrect departure time |
| 401 | The API key is missing or invalid | ||
| 403 | API key has expired and search limits have been exceeded | ||
| 500 | Internal server error |
Сoordinates – point coordinates
| Parameter | Description | Required/ Optional | Data type | Data Format |
| longitude | Longitude | required | number | double |
| latitude | Latitude | required | number | double |
Duration – the duration of the isochron time parameters
| Parameter | Description | Required/ Optional | Data type | Data Format |
| ms | The duration of the time parameter, in milliseconds | optional | integer | Int32 |
IsochroneContour – isochronous contour
| Parameter | Description | Required/ Optional | Data type | Data Format |
| geometry | Geometry | optional | array [Coordinates] | |
| center_pt | The central point of the isochron on request | optional | object {Coordinates} | |
| center_road_pt | The point of the road closest to the central point where the calculation is performed | optional | object {Coordinates} | |
| duration_sec | The time values for calculating isochronous contours, in seconds | optional | integer | int32 |
| status | Isochronous contour calculation status | optional | object {Isochron-eContourStatus} |
IsochroneContourStatus – status of the isochronous contour
| Parameter | Description | Required/ Optional | Data type | Data Format |
| code | Code. Possible options of code: • contour_ok — the isochron calculation has been successfully completed; • contour_empty — the contour of the isochron is empty; • contour_fail — an unknown error occurred when calculating the contour of the isochron; • lookup_fail — the point is located more than 10 km from the roads marked on the road map | optional | string enum: [contour_ok, con-tour_empty, con-tour_fail, lookup_fail] | |
| message | Message | optional | string |
Request
Response body
