1. Tiles API
  2. Routing API
  3. TSP API
  4. DistanceMatrix API
  5. Isochrones API
  6. LBS API
  7. GeoSuggest API
  8. JS API

API построения маршрутов

Сервис позволяет построить геометрию маршрута по заданным точкам (двум или более) и получить сведения о протяжённости маршрута и ориентировочном времени его прохождения. Предусмотрена возможность проложить маршрут как для пешехода, так и для транспортных средств с учетом их вида. При расчёте параметров маршрута можно учитывать информацию о дорожных пробках.
  • Авторизация
  • Ограничения
  • Запрос POST /routeId
  • Параметры тела запроса (RouteIdRequest)
  • Ответы (RouteIdResponse)
  • Запрос POST /routeMetadata
  • Параметры тела запроса (RouteMetadataRequest)
  • Ответы (RouteMetadataResponse)
  • Запрос POST /routeGeometry
  • Параметры тела запроса (RouteGeometryRequest)
  • Ответы (RouteGeometryResponse)
  • Запрос POST /calculateRoute
  • Параметры тела запроса (CalculateRouteRequest)
  • Ответы (CalculateRouteResponse)
  • Типы данных для API Получение деталей маршрута
  • Примеры использования
 НАЗАД

Для авторизации ключ API указывается в качестве значения параметра Api-Key заголовка запроса.

Ограничения устанавливаются для ключа: максимальное количество запросов в минуту, в день. Для построения одного маршрута можно указать до 100 точек. 

Для получения индивидуального идентификатора маршрута нужно отправить POST-запрос /routeId.

URL: https://webmapapi.navitel.ru/api/v1/routeId/

Координаты точек маршрута и другие параметры передаются в виде JSON в теле запроса.

Параметр Описание Обязательно/
Опционально		 Тип
данных		 Формат
данных
waypoints Координаты путевых точек, через которые необходимо построить маршрут required array [coordinates] – см. Типы данных для API Получение деталей маршрута  
vehicle_type Тип транспортного средства, для которого прокладывается маршрут.
Возможные значения:
• pedestrian – пешеход;
• bicycle – велосипедист;
• car – автомобиль;
• taxi – такси;
• bus – автобус;
• emergency – служба экстренной помощи;
• delivery – доставка;
• truck – грузовик 		required string enum: [pedestrian, bicycle, car, taxi, bus, emergency, delivery, truck]  
jams Учитывать ли при построении маршрута информацию о текущих дорожных пробках.
Значение по умолчанию: false		 optional boolean  
truck_limits Параметры транспортного средства типа «грузовик», которые учитываются при построении маршрута optional object {RouteIdTruckLimits} – см. Типы данных для API Получение деталей маршрута  
Код
ответа		 Параметр Тип
данных		 Описание
200 route_id object string Индивидуальный идентификатор маршрута
400 code string enum:
[empty_waypoints, invalid_object_type, invalid_waypoint, invalid_limits]		 Неверный запрос.
Возможные варианты code:
• empty_waypoints – пустой набор путевых точек;
• invalid_object_type – неправильный тип объекта;
• invalid_waypoint – одна из путевых точек задана неверно;
• invalid_limits – параметры транспортного типа «грузовик» заданы неверно
400 message string Неверный запрос.
Возможные варианты code:
• empty_waypoints – пустой набор путевых точек;
• invalid_object_type – неправильный тип объекта;
• invalid_waypoint – одна из путевых точек задана неверно;
• invalid_limits – параметры транспортного типа «грузовик» заданы неверно
401 Ключ API отсутствует или недействителен
403 Истёк срок действия ключа API, превышены пределы поиска
500 Внутренняя ошибка сервера

Для получения метаданных маршрута нужно отправить POST-запрос /routeMetadata.

URL: https://webmapapi.navitel.ru/api/v1/routeMetadata/

Параметры передаются в виде JSON в теле запроса.

Параметр Описание Обязательно/
Опционально		 Тип
данных		 Формат
данных
route_id Индивидуальный идентификатор прокладываемого маршрута required string  
Код
ответа		 Параметр Тип
данных		 Описание
200 length_meters number (double) Протяженность маршрута, в метрах
200 duration_seconds integer (int32) Ориентировочное время прохождения маршрута, в секундах
400 code string enum:
[invalid_route_id]		 Неверный запрос.
Возможные варианты code:
invalid_route_id – неправильный идентификатор маршрута
401 Ключ API отсутствует или недействителен
403 Истёк срок действия ключа API, превышены пределы поиска
500 Внутренняя ошибка сервера

Для получения сведений о геометрии маршрута нужно отправить POST-запрос /routeGeometry.

URL: https://webmapapi.navitel.ru/api/v1/routeGeometry/

Координаты точек маршрута и другие параметры передаются в виде JSON в теле запроса.

Параметр Описание Обязательно/
Опционально		 Тип
данных		 Формат
данных
route_id Индивидуальный идентификатор маршрута required string
viewport Если выставлен этот параметр, будет показана геометрия маршрута для указанной области видимости. Область видимости — прямоугольная область на карте в пиксельных координатах. С учетом масштаба карты геометрия маршрута в этой области генерализуется. Если параметр не задан, будет получена геометрия всего маршрута. optional object {RouteIdViewport} — см. Типы данных для API Получение деталей маршрута
Код
ответа		 Параметр Тип
данных		 Описание
200 lines object [GeoLine] – см. Типы данных для API Получение деталей маршрута Геометрия маршрута в виде последовательного набора полилиний в пространстве
400 code string enum:
[invalid_route_id, invalid_viewport_width, invalid_viewport_height, invalid_viewport_zoom, invalid_viewport_center]		 Неверный запрос.
Возможные варианты code:
• invalid_route_id – неправильный идентификатор маршрута;
• invalid_viewport_width – неправильная ширина области видимости;
• invalid_viewport_height – неправильная высота области видимости;
• invalid_viewport_zoom – неправильный масштаб, указанный в области видимости;
• invalid_viewport_center – неправильная центральная точка, указанная в области видимости
400 message string Неверный запрос.
Возможные варианты code:
• invalid_route_id – неправильный идентификатор маршрута;
• invalid_viewport_width – неправильная ширина области видимости;
• invalid_viewport_height – неправильная высота области видимости;
• invalid_viewport_zoom – неправильный масштаб, указанный в области видимости;
• invalid_viewport_center – неправильная центральная точка, указанная в области видимости
401 Ключ API отсутствует или недействителен
403 Истёк срок действия ключа API, превышены пределы поиска
500 Внутренняя ошибка сервера

Для получения сведений о построении маршрута нужно отправить POST-запрос /calculateRoute.

URL: https://webmapapi.navitel.ru/api/v1/calculateRoute/

Координаты точек маршрута и другие параметры передаются в формате JSON в теле запроса.

Параметр Описание Обязательно/ Опционально Тип данных Формат данных
language_id Идентификатор языка в формате языкового тега из списка BCP 47. Ответ на запрос представлен на указанном языке. Если в карте, по которой строится маршрут, отсутствует указанный язык, то ответ будет представлен на английском языке. Возможные варианты: ar_SA - арабский (Саудовская Аравия), cs_CZ - чешский (Республика Чехия), da_DK - датский (Дания), de_DE - немецкий (Германия), el_GR - греческий (Греция), en_US - английский (США), en_AU - английский (Австралия), en_GB - английский (Великобритания), en_IE - английский (Ирландия), en_ZA - английский (Южная Африка), es_ES - испанский (Испания), es_MX - испанский (Мексика), fi_FI - финский (Финляндия), fr_FR - французский (Франция), fr_CA - французский (Канада), he_IL - иврит (Израиль), hi_IN - хинди (Индия), hu_HU - венгерский (Венгрия), id_ID - индонезийский (Индонезия), it_IT - итальянский (Италия), ja_JP -японский (Япония), ko_KR - Корейский (Республика Корея), nl_BE - нидерландский (Бельгия), nl_NL - нидерландский (Нидерланды), no_NO - норвежский (Норвегия), pl_PL - польский (Польша), pt_PT - португальский (Португалия), pt_BR - португальский (Бразилия), ro_RO - румынский (Румыния), ru_RU - русский (Россия), sk_SK - словацкий (Словакия), sv_SE - шведский (Швеция), th_TH - тайский (Таиланд), tr_TR - турецкий (Турция), zh_CN - китайский (КНР), zh_HK - китайский (Гонконг), zh_TW - китайский (Тайвань) required string enum: [ar_SA, cs_CZ, da_DK, de_DE, el_GR, en_US, en_AU, en_GB, en_IE, en_ZA, es_ES, es_MX, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hu_HU, id_ID, it_IT, ja_JP, ko_KR, nl_BE, nl_NL, no_NO, pl_PL, pt_PT, pt_BR, ro_RO, ru_RU, sk_SK, sv_SE, th_TH, tr_TR, zh_CN, zh_HK, zh_TW]
vehicle_type Вид транспортного средства, для которого проложен маршрут. Возможные значения:
  • car - машина;
  • truck - самосвал;
  • heavy_truck - фура;
  • van - фургон;
  • bicycle - велосипед;
  • pedestrian - пешеход
 required string enum: [car, truck, heavy_truck, van, bicycle, pedestrian]
start_time Время отправления. Если не задано, будет использоваться текущее время optional string example: 2025-02-28T15:30:00Z date-time
via_points Точки посещения на маршруте required array [RouteViaPoint] - см. Типы данных ниже
mz_pass Наличие у водителей грузовых транспортных средств пропусков в зоны Московской кольцевой автомобильной дороги (МКАД), Третьего транспортного кольца (ТТК), Садового кольца (СК) optional object {MzPass} - см. Типы данных ниже
jams Учитывать ли при построении маршрута информацию о текущих дорожных пробках. Значение по умолчанию: false optional boolean
optimization Тип оптимизации маршрута:
  • по времени: fastest - самый быстрый;
  • по расстоянию: shortest - кратчайший.
Значение по умолчанию: fastest 		optional string enum: [fastest, shortest]
Код ответа Параметр Тип данных Описание
200 route object {RouteData} – см. Типы данных ниже Построенный маршрут между указанными точками
400 code string enum: [bad_points, no_route, too_many_points, invalid_time] Неверный запрос. Возможные варианты code: 
  • bad_points – точки находятся за пределами карты,
  • no_route – маршрут не может быть построен,
  • too_many_points – количество точек превышает допустимое значение, 
  • invalid_time – неверное время отправления
message string
401     Ключ api отсутствует или недействителен
403     Истёк срок действия ключа api, превышены пределы поиска
500     Внутренняя ошибка сервера

Сoordinates – координаты точки<

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
longitude  Долгота в градусах; интервал допустимых значений [-180, 180] required number double
latitude Широта в градусах, интервал допустимых значений [-90, 90] required number double

CoordinatesArray – массив координат точек<

Параметр Описание Обязательно/ Опционально Тип данных Формат данных
Массив пар координат точек маршрута Порядок координат: 0 – longitude,  1 – latitude required array [number]  double

GeoLine – геометрия маршрута в виде последовательного набора полилиний в пространстве<

Параметр Описание Обязательно/Опционально Тип данных Формат данных
points Точки маршрута optional array [CoordinatesArray]  

RouteIdTruckLimits – параметры транспортных средств типа «грузовик», используемые при построении маршрута

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
total_weight_kg Общая масса транспортного средства, в килограммах optional integer int32
axle_weight_kg Нагрузка на ось транспортного средства, в килограммах optional integer int32
width_meters Ширина транспортного средства, в метрах optional number float
height_meters Высота транспортного средства, в метрах optional number float
length_meters Длина транспортного средства, в метрах optional number float

RouteIdViewport – область видимости на карте (прямоугольная, в пиксельных координатах)

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
width_px Ширина области видимости на карте, в пикселях required integer uint32
height_px Высота области видимости на карте, в пикселях required integer int32
zoom Коэффициент масштабирования, в диапазоне от 3 до 18 включительно required integer uint32
center Координаты центральной точки карты required object {Coordinates}  

RouteData – данные о маршруте

<
Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
points Точки маршрута optional array [RoutePoint]  
via_points Промежуточные точки маршрута optional array [RouteViaPointIndex]  
streets Характеристики улиц, по которым проходит маршрут array [RouteStreet]  
maneuvers Характеристики маневров маршрута optional array [RouteManeuver]  

RoutePoint – точка маршрута

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
coordinates Координаты точки маршрута required object {Coordinates}  
h_level 3D-уровень дороги optional integer int32
street_index Индекс улицы optional integer int32
maneuver_index Индекс маневра optional Integer
-1 == no 		int32
distance_to_finish Дистанция (расстояние) до финиша optional integer int32
distance_from_start Дистанция (расстояние) от начала маршрута optional integer int32
distance_to_via Дистанция до ближайшей точки посещения маршрута optional integer int32
jam_level Уровень загруженности дорог.
Диапазон возможных значений: от 0 до 32 включительно, где 0 – дорога заблокирована, 32 – дорога свободна 		optional Integer [0-32], 0 – blocked, 32 – free int32

RouteViaPoint – промежуточная точка маршрута

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
coordinates Координаты промежуточной точки маршрута required object {Сoordinates}  
waiting_time Время ожидания в промежуточной точке маршрута, в секундах optional integer int32

RouteViaPointIndex – информация о точке посещения на маршруте

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
via_index Индекс точки посещения на маршруте optional integer
(index in CalculateRouteRequest.via_points) 		int32
arrival_time Время прибытия optional integer int32
segment_time Время прохождения сегмента маршрута, в секундах optional Integer int32
segment_length Длина сегмента маршрута, в метрах optional Integer  int32
point_index Индекс точки маршрута optional integer int32

RouteStreet – информация об улицах, по которым проходит маршрут

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
speed_limit_kph Ограничение скорости, км/ч optional integer int32
actual_speed_kph Текущая скорость, км/ч optional integer int32
street Название улицы optional string  
city Название города optional string  
ramp Съезд optional boolean  
tunnel Тоннель optional boolean  
roundabout Кольцевое движение optional boolean  
highway_road Автомагистраль optional boolean  
unpaved_road Грунтовая дорога optional boolean  
toll_road Платная дорога optional boolean  
ferry Паром optional boolean  
no_through Запрет транзитного проезда optional boolean  
road_class Тип и класс дороги.
Возможные значения (класс и тип дороги):
  • класс 0: аллея, тропа; переулок, внутриквартальный проезд; паром; грунтовая дорога; улучшенная грунтовая дорога; улица малая;
  • класс 1: улица крупная; круговое движение;
  • класс 2: городская магистраль; прочие загородные дороги;
  • класс 3: шоссе основное;
класс 4: соединительное шоссе; автомагистраль 		optional integer int32
lanes_count Количество полос на дороге optional integer int32

RouteManeuver – информация о маневрах маршрута

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
type Тип маневра.
Возможные значения:
  • keep_left – держитесь левее;
  •  keep_right – держитесь правее; 
  • left – поверните налево;
  • right – поверните направо; 
  • sharp_left – крутой поворот налево; 
  • sharp_right – крутой поворот нарпаво; 
  • to_roundabout – круговое движение; 
  • u_turn_right – разворот направо;
  • u_turn_left – разворот налево
 optional string enum: [keep_left, keep_right, left, right, sharp_left, sharp_right, to_roundabout, u_turn_right, u_turn_left] string
coordinates Координаты перекрёстка  optional object {Coordinates}  
next_angle Угол поворота optional integer int32
point_index Индекс точки optional integer int32
other_angles Другие углы дорог перекрёстка optional integer int64
to_ramp На развязку optional boolean  
tunnel Тоннель optional boolean  
to_roundabout К кольцу optional boolean  
on_roundabout На кольце optional boolean  
from_roundabout С кольца optional boolean  
bifurcation Развилка optional boolean  
cross_road Перекрёсток optional boolean  
street_changed Изменение улицы optional boolean  
uturn Разворот optional boolean  

MzPass – наличие пропуска в зоны МКАД, ТТК, СК

Параметр Описание Обязательно/ Опционально Тип данных Формат  данных
mkad Наличие пропуска в зону Московской кольцевой автодороги (МКАД).
Значение по умолчанию: false 		optional boolean  
ttk Наличие пропуска в зону Третьего транпортного кольца (ТТК).
Значение по умолчанию: false 		optional boolean  
sk Наличие пропуска в зону Садового кольца (СК).
Значение по умолчанию: false 		optional boolean  

Запрос POST /routeId

Ответ на запрос POST /routeId

Запрос POST /routeMetadata

Ответ на запрос POST /routeMetadata

Запрос POST /routeGeometry

Ответ на запрос POST /routeGeometry

Запрос POST /calculateRoute

Ответ на запрос POST /calculateRoute
  1. Tiles API
  2. Routing API
  3. TSP API
  4. DistanceMatrix API
  5. Isochrones API
  6. LBS API
  7. GeoSuggest API
  8. JS API

Routing API

The service allows you to build the geometry of a route based on given points (two or more) and obtain information about the length of the route and the approximate time of its completion.

It is possible to create a route for both pedestrians and vehicles, taking into account their type.

When calculating route parameters, you can take into account information about traffic jams.

  • Authorization
  • Limits
  • Request POST /routeId
  • Request body parameters (RouteIdRequest)
  • Responses (RouteIdResponse)
  • Request POST /routeMetadata
  • Request body parameters (RouteMetadataRequest)
  • Responses (RouteMetadataResponse)
  • Request POST /routeGeometry
  • Request body parameters (RouteGeometryRequest)
  • Responses (RouteGeometryResponse)
  • Request POST /calculateRoute
  • Request body parameters (CalculateRouteRequest)
  • Responses (CalculateRouteResponse)
  • Data types for the Getting route details API
  • Examples
 BACK

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. To build one route, you can specify up to 100 points. 

To obtain an individual route identifier, you need to send a POST request /routeId.

URL: https://webmapapi.navitel.ru/api/v1/routeId/

Waypoints coordinates and other parameters are sent as JSON in the request body.

Parameter Description Required/
Optional		 Data
type		 Data
Format
waypoints Coordinates of waypoints through which you need to build a route required array [Coordinates] – see Data types for the Getting route details API  
vehicle_type The type of vehicle for which the route is being laid.
Possible values:
• pedestrian;
• bicycle;
• car;
• taxi;
• bus;
• emergency;
• delivery;
• truck		 required string enum: [pedestrian, bicycle, car, taxi, bus, emergency, delivery, truck]  
jams To take into account or not when planning a route information about current traffic jams.
Default value: false		 optional boolean  
truck_limits Parameters of a vehicle of the “truck” type, which are taken into account when constructing a route optional object {RouteIdTruckLimits} – see Data types for the Getting route details API  
Response
Code		 Parameter Data
type		 Description
200 route_id object string Individual route identifier
400 code string enum:
[empty_waypoints, invalid_object_type, invalid_waypoint, invalid_limits]		 Invalid request.
Possible options of code:
• empty_waypoints – empty set of waypoints;
• invalid_object_type – wrong object type;
• invalid_waypoint – one of the waypoints is set incorrectly;
• invalid_limits – parameters of the transport type “truck” are set incorrectly
400 message string Invalid request.
Possible options of code:
• empty_waypoints – empty set of waypoints;
• invalid_object_type – wrong object type;
• invalid_waypoint – one of the waypoints is set incorrectly;
• invalid_limits – parameters of the transport type “truck” are set incorrectly
401     The API key is missing or invalid
403     API key has expired and search limits have been exceeded
500     Internal server error

To obtain route metadata, you need to send a POST request /routeMetadata.

URL: https://webmapapi.navitel.ru/api/v1/routeMetadata/

Parameters are sent as JSON in the request body.

Parameter Description Required/
Optional		 Data
type		 Data
Format
route_id Individual identifier of the route being laid required string  
Response
Code		 Parameter Data
type		 Description
200 length_meters number (double) Route length, meters
200 duration_seconds uint32 Approximate time to complete the route, in seconds
400 code string enum:
[invalid_route_id]		 Invalid request.
Possible options of code:
• invalid_route_id
400 message string Invalid request.
Possible options of code:
• invalid_route_id
401     The API key is missing or invalid
403     API key has expired and search limits have been exceeded
500     Internal server error

To obtain information about the route geometry, you need to send a POST request /routeGeometry.

URL: https://webmapapi.navitel.ru/api/v1/routeGeometry/

Waypoints coordinates and other parameters are sent as JSON in the request body.

Parameter Description Required/
Optional		 Data
type		 Data
Format
route_id Individual route identifier required string  
viewport If this parameter is set, the route geometry for the specified scope will be shown. Viewport is a rectangular area on the map in pixel coordinates. Taking into account the scale of the map, the geometry of the route in this area is generalized. If the parameter is not specified, the geometry of the entire route will be obtained optional object {RouteIdViewport} – see Data types for the Getting route details API  
Response
Code		 Parameter Data
type		 Description
200 lines object [GeoLine] – see Data types for the Getting route details API Route geometry as a sequential set of polylines in space
400 code string enum:
[invalid_route_id, invalid_viewport_width, invalid_viewport_height, invalid_viewport_zoom, invalid_viewport_center]		 Invalid request.
Possible options of code:
• invalid_route_id;
• invalid_viewport_width;
• invalid_viewport_height;
• invalid_viewport_zoom – incorrect scale specified in the viewport;
• invalid_viewport_center – incorrect center point specified in the viewport
400 message string Invalid request.
Possible options of code:
• invalid_route_id;
• invalid_viewport_width;
• invalid_viewport_height;
• invalid_viewport_zoom – incorrect scale specified in the viewport;
• invalid_viewport_center – incorrect center point specified in the viewport
401     The API key is missing or invalid
403     API key has expired and search limits have been exceeded
500     Internal server error
To obtain information about route construction, you need to send a POST request /calculateRoute. URL: https://webmapapi.navitel.ru/api/v1/calculateRoute/ Waypoints coordinates and other parameters are sent as JSON in the request body.
Parameter Description Required/ Optional Data type Data format
language_id Language ID in language tag format from the BCP 47 list. The response to the request is presented in the specified language. If the map on which the route is being built does not contain the specified language, then the answer will be presented in English. Possible options:  ar_SA – Arabic (Saudi Arabia); cs_CZ – Czech (Czech Republic); da_DK – Danish (Denmark); de_DE – German (Germany); el_GR – Greek (Greece); en_US – English (US); en_AU – English (Australia); en_GB – English (UK); en_IE – English (Ireland); en_ZA – English (South Africa); es_ES – Spanish (Spain); es_MX – Spanish (Mexico); fi_FI – Finnish (Finland); fr_FR – French (France); fr_CA – French (Canada); he_IL – Hebrew (Israel); hi_IN – Hindi (India); hu_HU – Hungarian (Hungary); id_ID – Indonesian (Indonesia); it_IT – Italian (Italy); ja_JP – Japanese (Japan); ko_KR – Korean (Republic of Korea); nl_BE – Dutch (Belgium); nl_NL – Dutch (Netherlands); no_NO  – Norwegian (Norway); pl_PL – Polish (Poland); pt_PT – Portuguese (Portugal); pt_BR – Portuguese (Brazil); ro_RO – Romanian (Romania); ru_RU – Russian Russia); sk_SK – Slovak (Slovakia); sv_SE – Swedish (Sweden); th_TH – Thai (Thailand); tr_TR – Turkish (Türkiye); zh_CN – Chinese (PRC); zh_HK – Chinese (Hong Kong); zh_TW – Chinese (Taiwan) required string enum: [ar_SA, cs_CZ, da_DK, de_DE, el_GR, en_US, en_AU, en_GB, en_IE, en_ZA, es_ES, es_MX, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hu_HU, id_ID, it_IT, ja_JP, ko_KR, nl_BE, nl_NL, no_NO, pl_PL, pt_PT, pt_BR, ro_RO, ru_RU, sk_SK, sv_SE, th_TH, tr_TR, zh_CN, zh_HK, zh_TW]  
vehicle_type Types of vehicles used. Possible options:
  • car,
  • truck,
  • heavy_truck,
  • van,
  • bicycle,
  • pedestrian
 required string enum: [car, truck, heavy_truck, van, bicycle, pedestrian]  
start_time Departure time. If not specified, the current time will be used optional string example: 2025-02-28T15:30:00Z date-time
via_points Points of visit along the route required array [RouteViaPoint] – see Data types below  
mz_pass Drivers of freight vehicles must have passes to the Moscow Ring Road (MKAD), Third Transport Ring (TTK), and Garden Ring (GR) zones optional object {MzPass} – see Data types below  
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:
  • by time – fastest; 
  • by distance – shortest.
Default value: fastest 		optional string enum: [fastest, shortest]  
Response code Parameter Data type Description
200 route object {TspRoute} – see Data types below Constructed route between specified points
400 code string
enum:
[bad_points, no_route, too_many_points, invalid_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
message string
401     The API key is missing or invalid
403     API key has expired and search limits have been exceeded
500     Internal server error

Сoordinates – coordinates of a point

Parameter Description Required/
Optional		 Data
type		 Data
Format
longitude Longitude in degrees; range of acceptable values [-180, 180] required number double
latitude Latitude in degrees, the range of acceptable values [-90, 90] required number double

CoordinatesArray – array of coordinates of points

Parameter Description Required/
Optional		 Data
type		 Data
Format
Array of pairs of coordinates of route points The order of coordinates:
0 – longitude,
1 – latitude		 required array [number] double

GeoLine – the geometry of the route in the form of a sequential set of polylines in space

Parameter Description Required/
Optional		 Data
type		 Data
Format
points Points of route optional array [CoordinatesArray]  

RouteIdTruckLimits – parameters of a vehicle of the “truck” type, which are taken into account when constructing a route

Parameter Description Required/
Optional		 Data
type		 Data
Format
total_weight_kg The total weight of the vehicle, in kilograms optional integer int32
axle_weight_kg Axle load of the vehicle, in kilograms optional integer int32
width_meters Width of the vehicle, in meters optional number float
height_meters Vehicle height, in meters optional number float
length_meters The length of the vehicle, in meters optional number float

RouteIdViewport – viewport on the map (rectangular, in pixel coordinates)

Parameter Description Required/
Optional		 Data
type		 Data
Format
width_px The width of the viewport on the map, in pixels required integer uint32
height_px The height of the viewport on the map, in pixels required integer int32
zoom Zoom level, in the range from 3 to 18 inclusive integer integer uint32
center Coordinates of the central point of the map required object {Сoordinates} – see Data types for the Getting route details API  

RouteData – information about the route

Parameter Description Required/ Optional Data type Data  format
points Waypoints optional array [RoutePoint]  
via_points Visiting points optional array [RouteViaPointIndex]  
streets Characteristics of the streets along which the route passes optional array [RouteStreet]  
maneuvers Characteristics of route maneuvers optional array [RouteManeuver]  

RoutePoint – waypoint

Parameter Description Required/ Optional Data type Data format
coordinates Waypoint coordinates required object {Coordinates}  
h_level 3D road level optional integer int32
street_index Street index optional integer int32
maneuver_index Maneuver index optional Integer -1 == no int32
distance_to_finish Distance to finish optional integer int32
distance_from_start Distance from the start of the route optional integer int32
distance_to_via Distance to the nearest visiting point on the route optional integer int32
jam_level Road congestion level optional Integer [0-32], 0 – blocked, 32 – free int32

RouteViaPoint – visiting point on the route 

Parameter Description Required/Optional Data type Data format
coordinates Coordinates of the intermediate route point required object {Coordinates}  
waiting_time Waiting time at an intermediate point on the route, in seconds optional integer int32

RouteViaPointIndex – information about the visiting point on the route

Parameter Description Required/ Optional Data type Data format
via_index Index of the visiting point on the route optional Integer (index in CalculateRouteRequest.via_points) int32
arrival_time Arrival time optional integer int32
segment_time Time to cover a route segment, in seconds optional Integer int32
segment_length The length of the route segment, in meters optional Integer  int32
point_index The index of the route point optional integer int32

RouteStreet – information about the streets along which the route passes 

Parameter Description Required/ Optional Data type Data format
speed_limit_kph Speed limit, kmph optional integer int32
actual_speed_kph Current speed, kmph optional integer int32
street Street name optional string  
city City name optional string  
ramp Ramp optional boolean  
tunnel Tunnel optional boolean  
roundabout Roundabout optional boolean  
highway_road Highway optional boolean  
unpaved_road Unpaved road optional boolean  
toll_road Toll road optional boolean  
ferry Ferryboat optional boolean  
no_through Transit ban optional boolean  
road_class Road type and class.
Possible values (road class and type):
  • class 0: walkway/trail; alleyway/private driveway; water or rail ferry; unpaved road; earth or gravel road; residential street;
  • class 1: collector road; roundabout;
  • class 2: arterial road; other highway road;
  • class 3: principal highway;
  • class 4: major highway connector; major highway
 optional integer int32
lanes_count Number of lanes on the road optional integer int32

RouteManeuver – information about route maneuvers

Parameter Description Required / optional   Data type Data format
type Maneuver type. Possible options:
  • keep left;
  • keep right;
  • left;
  • right;
  • sharp left;
  • sharp right;
  • to roundabout;
  • U-turn right;
  • U-turn left
 optional   string enum: [keep_left, keep_right, left, right, sharp_left, sharp_right, to_roundabout, u_turn_right, u_turn_left]
string
coordinates Intersection coordinates optional   object {Coordinates}  
next_angle Angle of rotation optional   integer int32
point_index Point index optional   integer int32
other_angles Other angles of the intersection roads optional   integer int64
to_ramp To the ramp optional   boolean  
tunnel Tunnel optional   boolean  
to_roundabout To the roundabout optional   boolean  
on_roundabout On the roundabout optional   boolean  
from_roundabout From the roundabout optional   boolean  
bifurcation Bifurcation optional   boolean  
cross_road Crossroad optional   boolean  
street_changed Changing the street optional   boolean  
uturn U-turn optional   boolean  

MzPass – availability of a pass to the MKAD, TTK, SK zones 

Parameter Description Required/ Optional Data type Data  format
mkad Availability of a pass to the Moscow Ring Road (MKAD) zone. Default value: false optional boolean   
ttk Availability of a pass to the Third Transport Ring (TTK) zone. Default value: false optional boolean   
sk Availability of a pass to the Garden Ring (GR) zone. Default value: false  optional boolean  

Request POST /routeId

Response to the request POST /routeId

Request POST /routeMetadata

Response to the request POST /routeMetadata

Request POST /routeGeometry

Response to the request POST /routeGeometry

Request POST /calculateRoute

Response to the request POST /calculateRoute

Поиск и карта сайта

Политика конфиденциальности

© АО «ЦНТ»2025