Документация API, SDK и руководства по интеграции
Изучите эндпоинты API, авторизацию, лимиты и примеры. Подключите мобильные SDK, CLI, MCP, стили карт, поиск мест и дорожные данные.
Каталог API
Найдите API по названию, задаче или пути запроса. Ссылки ведут к параметрам, примерам и ограничениям.
Навигация (10)
- Routing API →
Постройте автомобильный, велосипедный или пешеходный маршрут через точки в указанном порядке. Для инструкций передайте steps=true, для GeoJSON — geometries=geojson.
GET /api/v1/osrm/route/v1/{profile}/{coordinates} - Isochrones API →
Оценивает доступность по времени поездки до выборочных точек. Если в каждом направлении есть достижимая точка, quality.status равен estimated; иначе возвращаются insufficient_data и пустой polygons. Пустой результат не доказывает отсутствие доступных дорог. Граница приблизительна; поддерживается только ограничение времени.
GET /api/1/isochrone - Map Matching API →
Привязывает неточные GPS-треки к реальной дорожной сети (snap to road). Используется для очистки шума в GPS-сигналах.
GET /api/v1/osrm/match/v1/{profile}/{coordinates} - Nearest API →
Привязывает любую координату к ближайшему реальному сегменту дороги (snap) и возвращает информацию о названии дороги.
GET /api/v1/osrm/nearest/v1/{profile}/{coordinates} - Directions API →
Возвращает пошаговую навигацию между двумя и более точками с чистым списком инструкций (текст, расстояние, время, тип манёвра и координаты). Поддерживает авто, велосипед и пешехода, а также до 3 альтернативных маршрутов в одном вызове.
GET /api/1/directions - Alternative Routes API →
Возвращает пошаговую навигацию между двумя и более точками с чистым списком инструкций (текст, расстояние, время, тип манёвра и координаты). Поддерживает авто, велосипед и пешехода, а также до 3 альтернативных маршрутов в одном вызове.
GET /api/1/directions - Snap to Road API →
Привязывает сырые, неточные GPS-точки к ближайшему положению на дорожной сети. Повторите параметр point для каждой координаты (до 100).
GET /api/1/snap - API оценки расхода топлива →
Оцените топливо и стоимость поездки по расстоянию, фактической массе, расходу без груза/с полной загрузкой и цене за литр. Отдельно или в Truck.
POST /api/v1/fuel/estimate - Truck Routing API →
Планируйте грузовые маршруты внутри страны и через границы там, где есть дорожное сообщение. Передавайте габариты и массу гружёной машины в каждом запросе.
POST /api/v1/truck/route - Search Along Route API →
Сравнивайте остановки и дополнительное время поездки вдоль маршрута.
POST /api/v1/places/along-route
Операции и планирование загрузки (7)
- Route Optimization API →
Планирует маршруты с ограничениями вместимости, временных окон, навыков и связанных операций забора/доставки. Эвристика с ограничением времени сокращает поездки, но не гарантирует глобальный оптимум. Неназначенные задания остаются в solution.unassigned; некорректный ввод отклоняется целиком.
POST /api/1/vrp - Matrix API →
Рассчитайте время, расстояние или оба показателя между точками отправления и прибытия. Параметры sources и destinations выбирают индексы в списке координат.
GET /api/v1/osrm/table/v1/{profile}/{coordinates} - Trip API (TSP) →
Упорядочьте остановки одного транспортного средства по дорожной сети. Для открытого маршрута передайте roundtrip=false&source=first&destination=last. Оптимальный порядок не гарантируется.
GET /api/v1/osrm/trip/v1/{profile}/{coordinates} - Кластеризация точек →
Группирует заданные координаты по их географической близости и плотности (разбивает на кластеры).
POST /api/1/cluster - Планирование загрузки →
Планируйте смешанные грузы для машин, полуприцепов и контейнеров. Проверяйте укладку, порядок и свободное место в 3D или подключайте API к своей системе.
POST /api/v1/load-plansGET /api/v1/load-plansGET /api/v1/load-plans/{id}Все эндпоинты (+38)
DELETE /api/v1/load-plans/{id}POST /api/v1/load-plans/{id}/cancelGET /api/v1/load-plans/{id}/worksheetGET /api/v1/load-plans/{id}/csvGET /api/v1/load-plans/{id}/modelGET /api/v1/load-plans/pricesGET /api/v1/load-plans/import-previewPOST /api/v1/load-plans/import-previewPOST /api/v1/load-plans/comparePOST /api/v1/load-plans/fleetPOST /api/v1/load-plans/{id}/placement-previewPOST /api/v1/load-plans/{id}/placement-revisionsGET /api/v1/load-plans/{id}/pdfGET /api/v1/load-plans/{id}/xlsxPOST /api/v1/load-plans/{id}/shareDELETE /api/v1/load-plans/{id}/sharePOST /api/v1/load-plans/shared-viewPOST /api/v1/load-plans/palletizePOST /api/v1/load-plans/{id}/axle-estimateGET /api/v1/load-plans/workspace/{kind}GET /api/v1/load-plans/workspace/{kind}/{id}PUT /api/v1/load-plans/workspace/{kind}/{id}DELETE /api/v1/load-plans/workspace/{kind}/{id}GET /api/v1/load-plans/webhookPOST /api/v1/load-plans/webhookDELETE /api/v1/load-plans/webhookGET /api/v1/load-plans/webhook/eventsPOST /api/v1/load-plans/webhook/events/{id}POST /api/v1/load-plans/multi-stopPOST /api/v1/load-plans/bulkPOST /api/v1/load-plans/packagingPOST /api/v1/load-plans/dispatchPOST /api/v1/load-plans/fulfillmentPOST /api/v1/load-plans/simulationGET /api/v1/load-plans/{id}/warehousePOST /api/v1/load-plans/{id}/warehouseGET /api/v1/load-plans/{id}/simulation-reportGET /api/v1/load-plans/partner - Аналитика поездки: подтверждение визита →
Подтверждение визита и стоянки из переданного трека.
POST /api/v1/trip-analytics/visit-proof - Оптимизация грузового парка →
Статические грузовые матрицы для конкретных машин.
POST /api/v1/truck/optimize
Поиск (8)
- Geocoding API →
Преобразует поисковый текст в географические координаты (прямое) или координаты в адрес (обратное). Быстрый автокомплит с устойчивостью к опечаткам — охватывает улицы, адреса и объекты (кафе, магазины, отели, офисы). Идеально для поиска по мере ввода.
GET /api/1/geocode - Places API →
Найдите объекты рядом с точкой — кафе, магазины, отели, банкоматы, аптеки и др. — с фильтром по категории и радиусу, сортировкой по расстоянию.
GET /api/1/places - Autocomplete API →
Быстрые, устойчивые к опечаткам подсказки мест по мере ввода, с учётом местоположения.
GET /api/1/autocomplete - Batch Geocoding API →
Геокодируйте до 100 адресов за запрос. Результаты возвращаются в порядке ввода. На каждый адрес расходуется один кредит.
POST /api/1/geocode/batch - Поиск на естественном языке →
Ищите места короткими запросами на английском.
POST /api/v1/search/natural - Сведения о местах →
Читайте атрибуты, предоставленные источником.
POST /api/v1/places/details - Structured Geocoding API →
Ищите адреса по улице, городу, индексу и стране.
POST /api/v1/search/structured - Suggest & Retrieve API →
Создавайте поиск мест с подсказками и безопасным получением результата.
POST /api/v1/search/suggestPOST /api/v1/search/retrieve
Карты (4)
- Предпросмотр стиля по тексту →
Опишите цвета и слои, затем проверьте карту.
POST /api/v1/studio/preview - Static Maps API →
Экспортируйте оформленные карты в PNG для отчётов и приложений.
POST /api/v1/maps/static - Studio API →
Управляйте стилями, наборами данных и публикацией из приложения.
GET /api/v1/studio/{resource}POST /api/v1/studio/{resource} - Стили карт и векторные тайлы →
Загрузите общедоступную базовую карту или опубликованный стиль в MapLibre. Публичные запросы не требуют ключа и не расходуют кредиты. Используйте URL тайлов из стиля и сохраняйте атрибуцию.
GET /api/basemaps/{style}GET /api/map-styles/{id}GET /api/map-styles/{id}/tiles/{dataset}/{z}/{x}/{y}Все эндпоинты (+2)
GET /api/private-maps/{id}GET /api/private-maps/{id}/tiles/{dataset}/{z}/{x}/{y}
Данные (15)
- Timezone API →
Часовой пояс IANA, текущее смещение UTC, статус летнего времени и местное время для любой координаты.
GET /api/1/timezone - Elevation API →
Высота над уровнем моря в метрах для любой координаты — одна точка или профиль всего маршрута.
GET /api/1/elevation - Boundary Lookup API →
Определите, в какой стране, регионе, городе и районе находится координата — при запросе с полигоном границы.
GET /api/1/boundary - Geofencing API →
Одним запросом проверьте, в какие ваши зоны попадает каждая точка — полигональные или круговые ограждения.
POST /api/1/geofence - Elevation Profile API →
Высота в каждой точке пути + общий подъём, спуск и расстояние — полный профиль маршрута.
POST /api/1/elevation/profile - Solar API →
Восход, закат, сумерки, солнечный полдень и длина дня для любой координаты и даты.
GET /api/1/solar - Geometry Utilities API →
Расстояние, азимут, площадь, центроид, упрощение и polyline encode/decode — геометрия как сервис.
POST /api/1/geometry - Coordinate Conversion API →
Преобразование широты/долготы в UTM и MGRS и обратно.
GET /api/1/convert - Country Info API →
Валюта, телефонный код, языки, столица и флаг любой страны по ISO-коду или названию.
GET /api/1/country - Dataset Query API →
Находите ближайшие объекты в собственных загруженных геоданных.
POST /api/v1/maps/datasets/{id}/query - API дорожных данных →
Ограничения скорости, свойства дорог и наблюдения дорожных знаков в доступных районах.
POST /api/v1/roads/lookupPOST /api/v1/roads/batch - Использование аккаунта →
Дорожные данные: 100 000 операций в месяц
POST /api/v1/roads/usage - API дорожных знаков →
Находите наблюдения дорожных знаков в выбранной области карты. Получайте классификацию, координаты, направление и даты наблюдений с постраничной выдачей.
POST /api/v1/roads/signs - Доказательство соответствия маршрута →
Подтверждённые источником данные скорости для позиций маршрута.
POST /api/v1/roads/compliance - Ограничение скорости на дороге →
Получите нанесённое на карту ограничение скорости для легковых автомобилей рядом с координатой. Если значение отсутствует или неоднозначно, возвращается null.
GET /api/1/speed-limit
Руководство по интеграции платформы (6)
- Асинхронные задачи →
Операции: geocode_batch, matrix, optimize. POST /api/jobs возвращает 202 и ID задачи. Одинаковые Idempotency-Key и содержимое возвращают существующую задачу; другое содержимое возвращает 409.
POST /api/jobsGET /api/jobsGET /api/jobs/{id}Все эндпоинты (+1)
DELETE /api/jobs/{id} - Sandbox API →
Проверьте обработку ответов в sandbox с тестовыми данными перед платным реальным запросом.
POST /api/sandbox - Метаданные источников →
Проверьте источники данных, географическое покрытие и актуальность данных по сервисам.
GET /api/source-metadata - Мобильный доступ →
Подключите приложение без встроенного секретного API-ключа.
POST /api/mobile/challengePOST /api/mobile/token - Удалённый MCP API →
Подключайте ИИ-инструменты к геосервисам.
POST /api/mcp - Эндпоинты совместимости →
Перед переходом на основной API проверьте порядок координат и единицы в ответе.
GET /api/v1/route/{profile}/{coordinates}GET /api/1/routeGET /api/1/route/infoВсе эндпоинты (+9)
GET /api/1/matrixPOST /api/1/matrixPOST /api/1/matrix/calculatePOST /api/1/matchPOST /api/1/elevationPOST /api/1/optimizePOST /api/1/vrp/optimizePOST /api/1/cluster/calculatePOST /api/1/batch-geocode
Введение
#OSRMRoute предоставляет API маршрутизации, планирования автопарка, поиска адресов, карт и геоданных. Найдите в каталоге руководство по нужной операции.
Текущие лимиты тарифов
Лимиты кредитов и запросов в минуту общие для всех ключей аккаунта. Дополнительный лимит ключа не увеличивает бюджет аккаунта. Сначала расходуются включённые, затем купленные кредиты.
Free включает API Routing, Route Optimization, Geocoding (включая обратный поиск адреса и автодополнение) и Matrix в пределах лимитов плана. Для Map Matching, Isochrone, Truck Routing, Fuel Estimate и других отдельных API нужен платный план, включая PAYG. Доступ к API определяется действующим планом аккаунта; положительный баланс сам по себе не отменяет ограничения Free. Для дорожных данных и AI сохраняются отдельные требования Business.
Route, Directions и Truck Routing: если после обработки запроса не найдена доступная дорога поблизости или связный маршрут, однократно списывается 0,5 кредита на всех подходящих планах, включая PAYG. Ошибки ввода, отказы доступа/плана или неподдерживаемого покрытия графа и ошибки сервера не оплачиваются. Сначала резервируется цена успешного запроса; остаток возвращается.
Загрузка лимитов…
Публичная карта поддерживает Route, Matrix, Match, Nearest и Trip с отдельными демолимитами. Для остальных сервисов используйте свой API-ключ и примеры ниже.
Аутентификация
#Передавайте ключ API как Bearer-токен в заголовке Authorization. Требуемые разрешения ключа и среду смотрите в руководстве операции. Некоторые старые эндпоинты принимают ключ в параметре URL.
Authorization: Bearer YOUR_API_KEYКоды ошибок
#OSRMRoute использует стандартные HTTP-коды статусов и подробные JSON-сообщения об ошибках для указания состояния запроса.
Ответ об ошибке содержит error и иногда code. Проверяйте HTTP-статус и заголовки остатка лимитов, а не только текст. Заголовки Reset описывают скользящее окно, а не сброс в полночь.
X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Compute-* · X-Quota-* · X-Credits-* · Retry-AfterПередайте действующий API-ключ и проверьте его статус.
{
"error": "Invalid API Key"
}Пополните баланс или выберите подходящий тариф.
{
"error": "Insufficient balance: this request costs 1 credit and your balance is 0 credits. Top up your account to continue."
}Проверьте лимиты сложности и ограничения ключа в кабинете.
{
"error": "This API Key is disabled"
}Учитывайте Retry-After и уменьшите частоту запросов.
{
"error": "Rate limit exceeded: this account has exceeded its configured requests-per-minute limit. Please slow down."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"error": "Internal Server Error"
}Routing API
#Постройте автомобильный, велосипедный или пешеходный маршрут через точки в указанном порядке. Для инструкций передайте steps=true, для GeoJSON — geometries=geojson.
/api/v1/osrm/route/v1/{profile}/{coordinates}Параметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| profile | string | Обязательный | driving | Профиль вида транспорта. Поддерживаемые значения: driving (автомобиль), cycling (велосипед), walking (пешеход). |
| coordinates | string | Обязательный | - | Координаты точек. Формат: lon,lat;lon,lat;lon,lat... (минимум 2 точки). |
| overview | string | Необязательный | simplified | Детализация возвращаемой геометрии маршрута: simplified (упрощённая), full (полная геометрия), false (без геометрии). |
| geometries | string | Необязательный | polyline | Формат геометрии: geojson (объект GeoJSON), polyline (закодированная строка). |
| steps | boolean | Необязательный | false | Возвращать ли пошаговые инструкции для каждого поворота. |
| alternatives | integer | boolean | Необязательный | false | Число альтернатив для поиска. Наличие зависит от дорожной сети. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/v1/osrm/route/v1/driving/49.8516,40.3777;49.86,40.40?steps=true&overview=full&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 кредит за каждый начатый блок из 10 входных точек, включая начало и конец.
Route, Directions и Truck Routing: если после обработки запроса не найдена доступная дорога поблизости или связный маршрут, однократно списывается 0,5 кредита на всех подходящих планах, включая PAYG. Ошибки ввода, отказы доступа/плана или неподдерживаемого покрытия графа и ошибки сервера не оплачиваются. Сначала резервируется цена успешного запроса; остаток возвращается.
Путь OSRM: lon,lat; GeoJSON: [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- snap_distance_m ≤ 2000
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"routes": [
{
"distance": 3200,
"duration": 420,
"geometry": {
"type": "LineString",
"coordinates": [
[
49.8516,
40.3777
],
[
49.86,
40.4
]
]
},
"legs": [
{
"distance": 3200,
"duration": 420,
"steps": []
}
]
}
],
"waypoints": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}API не смог обработать все точки в одной дорожной сети для выбранного профиля. Отправьте связанные участки отдельными запросами.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
Расстояние указано в метрах, время — в секундах. По умолчанию линия упрощена и передаётся в формате polyline. Для полной линии используйте overview=full.
Matrix API
#Рассчитайте время, расстояние или оба показателя между точками отправления и прибытия. Параметры sources и destinations выбирают индексы в списке координат.
/api/v1/osrm/table/v1/{profile}/{coordinates}Параметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| profile | string | Обязательный | driving | Транспортный профиль (driving, cycling, walking). |
| coordinates | string | Обязательный | - | Точки матрицы. Формат: lon,lat;lon,lat;lon,lat... |
| annotations | string | Необязательный | duration | Данные для вычисления: duration (время), distance (расстояние) или оба. |
| sources | string | Необязательный | all | Индексы отправления с нуля через точку с запятой или all. |
| destinations | string | Необязательный | all | Индексы прибытия с нуля через точку с запятой или all. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/v1/osrm/table/v1/driving/49.85,40.37;49.86,40.40;49.83,40.39?annotations=duration,distance" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: max(1, ceil(cells * 2 / 5))
Путь OSRM: lon,lat; GeoJSON: [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- cells = sources × destinations
- credits = max(1, ceil(cells * 2 / 5))
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"durations": [
[
0,
420
],
[
430,
0
]
],
"distances": [
[
0,
3200
],
[
3300,
0
]
],
"sources": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
},
{
"name": "Second road",
"location": [
49.86,
40.4
],
"distance": 3
}
],
"destinations": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
},
{
"name": "Second road",
"location": [
49.86,
40.4
],
"distance": 3
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}API не смог обработать все точки в одной дорожной сети для выбранного профиля. Отправьте связанные участки отдельными запросами.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "UnreachablePoints",
"error": "Some locations are disconnected in this road network."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
По умолчанию возвращается матрица durations. Укажите annotations=distance для расстояний или annotations=duration,distance для обеих матриц. Время указано в секундах, расстояние — в метрах. Если ни один подходящий граф не может рассчитать всю матрицу, для несвязанных точек возвращается HTTP 422 UnreachablePoints.
Map Matching API
#Привязывает неточные GPS-треки к реальной дорожной сети (snap to road). Используется для очистки шума в GPS-сигналах.
/api/v1/osrm/match/v1/{profile}/{coordinates}Параметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| geometries | string | Необязательный | polyline | Формат геометрии: geojson (объект GeoJSON), polyline (закодированная строка). |
| profile | string | Обязательный | driving | Транспортный профиль. |
| coordinates | string | Обязательный | - | Последовательность GPS-координат для привязки (lon,lat;lon,lat...) |
| overview | string | Необязательный | simplified | Точность геометрии сопоставленного маршрута. |
| timestamps | string | Необязательный | - | Неубывающие метки Unix в секундах, по одной на точку, через точку с запятой. |
| radiuses | string | Необязательный | - | Точность GPS в метрах, по одному значению на точку, через точку с запятой. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/v1/osrm/match/v1/driving/49.851536,40.375480;49.844011,40.379982;49.839336,40.389620;49.837774,40.389268?overview=full&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
Путь OSRM: lon,lat; GeoJSON: [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- tracepoints[]: object | null
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"matchings": [
{
"distance": 3200,
"duration": 420,
"geometry": {
"type": "LineString",
"coordinates": [
[
49.8516,
40.3777
],
[
49.86,
40.4
]
]
},
"legs": [
{
"distance": 3200,
"duration": 420,
"steps": []
}
],
"confidence": 0.97
}
],
"tracepoints": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
},
null
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}API не смог обработать все точки в одной дорожной сети для выбранного профиля. Отправьте связанные участки отдельными запросами.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
matchings[]: distance — расстояние (м), duration — длительность (с), confidence — уверенность (0–1), geometry — геометрия; tracepoints[] — объект или null.
Nearest API
#Привязывает любую координату к ближайшему реальному сегменту дороги (snap) и возвращает информацию о названии дороги.
/api/v1/osrm/nearest/v1/{profile}/{coordinates}Параметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| profile | string | Обязательный | driving | Транспортный профиль. |
| coordinates | string | Обязательный | - | Точка для поиска ближайшего. Формат: lon,lat (одна пара). |
| number | integer | Необязательный | 1 | Количество ближайших дорог-кандидатов для поиска. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/v1/osrm/nearest/v1/driving/49.8516,40.3777?number=3" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
Путь OSRM: lon,lat; GeoJSON: [lon,lat].
- coordinates: 1
- number: default = 1; example = 3
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"waypoints": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
waypoints[] → name, distance (m), location [lon,lat].
Trip API
#Упорядочьте остановки одного транспортного средства по дорожной сети. Для открытого маршрута передайте roundtrip=false&source=first&destination=last. Оптимальный порядок не гарантируется.
/api/v1/osrm/trip/v1/{profile}/{coordinates}Параметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| geometries | string | Необязательный | polyline | Формат геометрии: geojson (объект GeoJSON), polyline (закодированная строка). |
| profile | string | Обязательный | driving | Транспортный профиль. |
| coordinates | string | Обязательный | - | Точки для посещения. Формат: lon,lat;lon,lat... |
| source | string | Необязательный | any | Точка, с которой может начинаться маршрут (any или первая точка). |
| destination | string | Необязательный | any | Точка, в которой заканчивается маршрут (any или последняя точка). |
| roundtrip | boolean | Необязательный | true | Возвращаться к началу. Для false используйте source=first и destination=last. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/v1/osrm/trip/v1/driving/49.85,40.37;49.86,40.40;49.83,40.39?source=first&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 5 credits
Путь OSRM: lon,lat; GeoJSON: [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- credits = 5
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"trips": [
{
"distance": 3200,
"duration": 420,
"geometry": {
"type": "LineString",
"coordinates": [
[
49.8516,
40.3777
],
[
49.86,
40.4
]
]
},
"legs": [
{
"distance": 3200,
"duration": 420,
"steps": []
}
]
}
],
"waypoints": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2,
"trips_index": 0,
"waypoint_index": 0
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}API не смог обработать все точки в одной дорожной сети для выбранного профиля. Отправьте связанные участки отдельными запросами.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
trips[]: distance — расстояние (м), duration — длительность (с), geometry — геометрия; waypoints[]: trips_index, waypoint_index — индексы порядка, location [lon,lat] — координаты.
Directions API
#Возвращает пошаговую навигацию между двумя и более точками с чистым списком инструкций (текст, расстояние, время, тип манёвра и координаты). Поддерживает авто, велосипед и пешехода, а также до 3 альтернативных маршрутов в одном вызове.
/api/1/directionsПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | Точка: lat,lng. Повторите параметр для каждой остановки (минимум 2). |
| profile | string | Необязательный | driving | Способ передвижения: driving, cycling или walking. |
| alternatives | integer | Необязательный | 0 | Число дополнительно возвращаемых альтернативных маршрутов (0–3). |
| lang | string | Необязательный | en | Код языка для текста инструкций. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/directions?point=40.3777,49.8516&point=40.40,49.86&profile=driving" -H "Authorization: Bearer YOUR_KEY"curl "https://osrmroute.com/api/1/directions?point=40.3777,49.8516&point=40.40,49.86&alternatives=2" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 кредит за каждый начатый блок из 10 входных точек, включая начало и конец.
Route, Directions и Truck Routing: если после обработки запроса не найдена доступная дорога поблизости или связный маршрут, однократно списывается 0,5 кредита на всех подходящих планах, включая PAYG. Ошибки ввода, отказы доступа/плана или неподдерживаемого покрытия графа и ошибки сервера не оплачиваются. Сначала резервируется цена успешного запроса; остаток возвращается.
Вход point=lat,lng. Точки инструкций и остановок: [lat,lng]; GeoJSON: [lon,lat].
- point: repeat ≥ 2; count ≤ plan.maxRoutePoints
- alternatives: 0–3
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"profile": "driving",
"routes": [
{
"distance": 3200,
"duration": 420,
"geometry": {
"type": "LineString",
"coordinates": [
[
49.8516,
40.3777
],
[
49.86,
40.4
]
]
},
"instructions": [
{
"text": "Continue on Example road",
"type": "continue",
"modifier": "straight",
"distance": 300,
"duration": 40,
"name": "Example road",
"bearing_after": 90,
"location": [
40.3777,
49.8516
]
}
]
}
],
"waypoints": [
{
"name": "Example road",
"location": [
40.3777,
49.8516
]
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "At least two points must be provided (point=lat,lng repeated)."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}API не смог обработать все точки в одной дорожной сети для выбранного профиля. Отправьте связанные участки отдельными запросами.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
Возвращает { code, profile, routes[], waypoints[] }. У каждого маршрута есть distance (м), duration (с), геометрия GeoJSON и массив instructions[]; каждая инструкция включает text, type, modifier, distance, duration, name и location [lat,lng].
Snap to Road API
#Привязывает сырые, неточные GPS-точки к ближайшему положению на дорожной сети. Повторите параметр point для каждой координаты (до 100).
/api/1/snapПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | GPS-точка: lat,lng. Повторите параметр для каждой точки (максимум 100). |
| profile | string | Необязательный | driving | Дорожная сеть для привязки: driving, cycling или walking. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/snap?point=40.3778,49.8517&point=40.3801,49.8600" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- point: repeat 1–100
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"code": "Ok",
"profile": "driving",
"snapped": [
{
"input": [
40.3777,
49.8516
],
"snapped": [
40.3778,
49.8517
],
"distance": 14,
"name": "Example road"
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "At least one point must be provided (point=lat,lng repeated)."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
Возвращает { code, profile, snapped[] }. Каждый элемент содержит исходный input [lat,lng], привязанную позицию [lat,lng], расстояние привязки в метрах и название дороги.
Geocoding API
#Преобразует поисковый текст в географические координаты (прямое) или координаты в адрес (обратное). Быстрый автокомплит с устойчивостью к опечаткам — охватывает улицы, адреса и объекты (кафе, магазины, отели, офисы). Идеально для поиска по мере ввода.
/api/1/geocodeПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| q | string | Необязательный | - | Искомый адрес (например: «улица Низами, Баку»). |
| reverse | boolean | Необязательный | false | Должно быть true для обратного геокодинга (поиск от координат к адресу). |
| point | string | Необязательный | lat,lng | Координата (lat,lng) для обратного геокодирования в адрес. Обязательна при reverse=true. |
| limit | integer | Необязательный | 5 | Максимальное число результатов (1–20, по умолчанию 5). |
| lang | string | Необязательный | en | Предпочтительный язык названий результатов (например en, az, ru). По умолчанию en. |
| lat | number | Необязательный | - | Широта для смещения результатов (ближайшие — выше). Вместе с lon. |
| lon | number | Необязательный | - | Долгота для смещения результатов. Вместе с lat. |
| bbox | string | Необязательный | - | Ограничить результаты рамкой: minLon,minLat,maxLon,maxLat. |
| osm_tag | string | Необязательный | - | Фильтр по тегу OSM, напр. place (населённые пункты) или amenity:cafe. Префикс ! для исключения. |
| country | string | Необязательный | - | Двухбуквенный код ISO 3166-1 alpha-2, например AZ. Результаты только из этой страны. |
| city | string | Необязательный | - | Строгий фильтр города, например Baku. Требует ровно один код country. |
| elastic | boolean | Необязательный | true | Эластичный (нечёткий, высокая полнота) поиск — по умолчанию true. Терпим к опечаткам, отсутствию диакритики (ə↔e), порядку слов, общим словам (metro, rayonu) и номерам домов. false — строгое совпадение. |
Фильтры страны и города
Без country поиск глобальный. country=AZ ограничивает результаты Азербайджаном, country=AZ&city=Bakı — городом Баку в Азербайджане. Если совпадений нет, возвращается HTTP 200 с пустым списком, без расширения поиска. Город без страны или неверный код страны возвращает HTTP 400 InvalidGeocodeFilter. lat/lon влияют только на порядок по близости. Записи без подтверждённого города исключаются при фильтрации по городу.
GET /api/1/geocode?q=Nizami&country=AZ
GET /api/1/geocode?q=Nizami&country=AZ&city=Bak%C4%B1
HTTP 200: { "hits": [], "took": 12 }
HTTP 400: { "code": "InvalidGeocodeFilter", "error": "city requires exactly one country, for example country=AZ&city=Bakı." }Примеры
# Смещение к точке, только населённые пункты
GET /api/1/geocode?q=qala&lat=40.41&lon=49.87&osm_tag=place
# Только выбранная страна и город
GET /api/1/geocode?q=market&country=AZ&city=Bak%C4%B1
# Обратное геокодирование (координаты в адрес)
GET /api/1/geocode?reverse=true&point=40.409,49.867Для точного поиска передайте улицу и номер дома в q. locality и postcode требуют указания одной страны. unit выбирает точную запись помещения и включает address_mode=units. Режим buildings по умолчанию объединяет записи помещений с одинаковым местоположением.
/api/1/geocode?q=101+Main+Street&country=US&locality=Boston&postcode=02129&unit=2&address_mode=unitsПример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/geocode?q=Nizami&country=AZ&city=Bak%C4%B1&lang=az" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- limit: 1–20
- reverse: max_distance_m = 1000
- city: exactly 1 country
Успешный ответ без совпадений может содержать пустой список. Фильтры страны/города не расширяются. Детали адресов зависят от индекса.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"hits": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
],
"took": 12
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "The \"q\" parameter (search text) is required."
}Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidGeocodeFilter",
"error": "city requires exactly one country, for example country=AZ&city=Bakı."
}В радиусе обратного поиска нет индексированного адреса или места.
{
"code": "NoNearbyAddress",
"error": "No indexed address or place within 1 km."
}Пояснение структуры ответа
hits[]: name, city, country, countrycode — место и страна, point (lat,lng) — координаты; took — время (мс). reverse=true: source — источник, accuracy — точность, distance_m — расстояние.
Места (POI рядом)
#Найдите объекты рядом с точкой — кафе, магазины, отели, банкоматы, аптеки и др. — с фильтром по категории и радиусу, сортировкой по расстоянию.
/api/1/placesПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | Центральная координата lat,lng для поиска (обязательно). |
| radius | number | Необязательный | 1 | Радиус поиска в километрах (0.05–20, по умолчанию 1). |
| category | string | Необязательный | - | Фильтр по тегу OSM, напр. amenity:cafe, shop, tourism:hotel. Префикс ! для исключения. Пусто = все POI. |
| limit | integer | Необязательный | 10 | Макс. число результатов (1–50, по умолчанию 10). |
| lang | string | Необязательный | en | Предпочтительный язык названий (напр. en, az, ru). |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/places?point=40.371,49.845&radius=1&category=amenity:cafe" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- radius: 0.05–20 km
- limit: 1–50
Успешный ответ без совпадений может содержать пустой список. Фильтры страны/города не расширяются. Детали адресов зависят от индекса.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"places": [
{
"name": "Example cafe",
"category": "amenity",
"type": "cafe",
"distance_m": 85,
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
],
"took": 12
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "The \"point\" parameter (lat,lng) is required."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"error": "Places service unavailable."
}Пояснение структуры ответа
places[]: name, category, type — сведения о месте, distance_m — расстояние, point (lat,lng) — координаты; took — время (мс).
Autocomplete API
#Быстрые, устойчивые к опечаткам подсказки мест по мере ввода, с учётом местоположения.
/api/1/autocompleteПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| q | string | Обязательный | - | Текст запроса — допустим частичный ввод. |
| limit | integer | Необязательный | 8 | Максимальное число подсказок (1–15). |
| lang | string | Необязательный | en | Код языка для меток результатов. |
| lat | number | Необязательный | - | Широта для смещения результатов (необязательно). |
| lon | number | Необязательный | - | Долгота для смещения результатов (необязательно). |
| country | string | Необязательный | - | Двухбуквенный код ISO 3166-1 alpha-2, например AZ. Результаты только из этой страны. |
| city | string | Необязательный | - | Строгий фильтр города, например Baku. Требует ровно один код country. |
| osm_tag | string | Необязательный | - | Фильтр по типу OSM, напр. place:city. |
Фильтры страны и города
Без country поиск глобальный. country=AZ ограничивает результаты Азербайджаном, country=AZ&city=Bakı — городом Баку в Азербайджане. Если совпадений нет, возвращается HTTP 200 с пустым списком, без расширения поиска. Город без страны или неверный код страны возвращает HTTP 400 InvalidGeocodeFilter. lat/lon влияют только на порядок по близости. Записи без подтверждённого города исключаются при фильтрации по городу.
GET /api/1/autocomplete?q=Nizami&country=AZ
GET /api/1/autocomplete?q=Nizami&country=AZ&city=Bak%C4%B1
HTTP 200: { "suggestions": [], "took": 12 }
HTTP 400: { "code": "InvalidGeocodeFilter", "error": "city requires exactly one country, for example country=AZ&city=Bakı." }Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/autocomplete?q=niz&lang=az&lat=40.40&lon=49.86" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- limit: 1–15
- city: exactly 1 country
Успешный ответ без совпадений может содержать пустой список. Фильтры страны/города не расширяются. Детали адресов зависят от индекса.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"suggestions": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"label": "Nizami Street, Baku, Azerbaijan"
}
],
"took": 12
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "The \"q\" parameter (search text) is required."
}Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidGeocodeFilter",
"error": "city requires exactly one country, for example country=AZ&city=Bakı."
}Пояснение структуры ответа
Возвращает { suggestions[], took }. Каждая подсказка содержит label, name, city, state, country, countrycode, type, osm_id и point {lat,lng}.
Batch Geocoding API
#Геокодируйте до 100 адресов за запрос. Результаты возвращаются в порядке ввода. На каждый адрес расходуется один кредит.
/api/1/geocode/batchПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| queries | array | Обязательный | [] | Массив строк адресов для геокодирования (макс 100). |
| lang | string | Необязательный | en | Код языка для меток результатов. |
| limit | integer | Необязательный | 1 | Максимум совпадений на запрос (1–5). |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/geocode/batch" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"queries":["Nizami küçəsi 10","28 May, Bakı"],"lang":"az"}'Лимиты и координаты
Стоимость в кредитах: 1 credit / query
См. именованные поля JSON; запрос не требует пары координат.
- queries: 1–100
- limit: 1–5 / query
- credits = queries.length
Успешный ответ без совпадений может содержать пустой список. Фильтры страны/города не расширяются. Детали адресов зависят от индекса.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"results": [
{
"query": "Baku",
"hits": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
]
}
],
"count": 1,
"took": 12
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Body must include a non-empty \"queries\" array of address strings."
}Исправьте отсутствующие или неверные параметры.
{
"error": "A maximum of 100 queries can be geocoded per batch request."
}Пояснение структуры ответа
Возвращает { results[], count, took }. Каждый результат связывает входной query с массивом hits[]; каждое совпадение содержит label, city, country и point {lat,lng}. Порядок ввода сохраняется.
Timezone API
#Часовой пояс IANA, текущее смещение UTC, статус летнего времени и местное время для любой координаты.
/api/1/timezoneПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Необязательный | - | Передайте point=lat,lng либо оба параметра lat и lon. |
| lat | number | Необязательный | - | Широта (вместо point). |
| lon | number | Необязательный | - | Долгота (вместо point). |
| timestamp | string | Необязательный | now | Unix-время (секунды) или дата ISO для расчёта смещения; по умолчанию сейчас. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/timezone?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- timestamp: Unix seconds | ISO 8601; default = now
- utc_offset_seconds: seconds
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"timezone": "Asia/Baku",
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"utc_offset": "+04:00",
"utc_offset_seconds": 14400,
"dst": false,
"abbreviation": "GMT+4",
"local_time": "2026-01-01T16:00:00",
"utc_time": "2026-01-01T12:00:00.000Z"
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Пояснение структуры ответа
Возвращает { timezone, point, utc_offset, utc_offset_seconds, dst, abbreviation, local_time, utc_time }. utc_offset — строка +ЧЧ:ММ, dst равно true при летнем времени, а local_time — ISO-метка со смещением пояса.
Elevation API
#Высота над уровнем моря в метрах для любой координаты — одна точка или профиль всего маршрута.
/api/1/elevationПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | Координата: lat,lng. Повторяйте для каждой точки (до 100 в GET). |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/elevation?point=40.4093,49.8671&point=41.30,48.50" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit / 10 points
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- GET: point count = 1–100
- POST: points count = 1–1000
- credits = max(1, ceil(points / 10))
- elevation: number | null
- GET with 1 point: elevation alias
Высота может быть null при отсутствии данных. Не заменяйте неизвестную высоту нулём.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"results": [
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"elevation": null
}
],
"unit": "meters"
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide at least one point=lat,lng (repeatable)."
}Исправьте отсутствующие или неверные параметры.
{
"error": "A maximum of 100 points can be queried per GET request; use POST for larger batches."
}Пояснение структуры ответа
Возвращает { results[], unit:"meters" }, где каждый результат — { point:{lat,lng}, elevation }. elevation — метры над уровнем моря (null, если неизвестно, 0 над морем). Для одной точки также добавляется elevation верхнего уровня. Для больших наборов — POST { points:[[lat,lng],...] } (до 1000).
Boundary Lookup API
#Определите, в какой стране, регионе, городе и районе находится координата — при запросе с полигоном границы.
/api/1/boundaryПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | Координата: lat,lng. |
| polygon | boolean | Необязательный | false | true, чтобы также вернуть границу как GeoJSON. |
| lang | string | Необязательный | en | Код языка для названий. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/boundary?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- polygon: true | false
- HTTP 422: BoundaryCoverageUnavailable
Подробные границы доступны только в принятых региональных наборах. Для других точек возвращается BoundaryCoverageUnavailable.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"display_name": "Baku, Azerbaijan",
"boundary_scope": "city",
"country": "Azerbaijan",
"countrycode": "AZ",
"city": "Baku",
"boundary": {
"type": "Polygon",
"coordinates": [
[
[
49.84,
40.37
],
[
49.87,
40.37
],
[
49.87,
40.4
],
[
49.84,
40.37
]
]
]
}
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Подробные административные данные здесь недоступны. См. покрытие.
{
"code": "BoundaryCoverageUnavailable",
"error": "Detailed administrative boundary data is not available at this coordinate."
}Пояснение структуры ответа
Возвращает { point, display_name, country, countrycode, state, county, city, district, postcode, osm_id, osm_type }, а при polygon=true — геометрию границы GeoJSON.
Geofencing API
#Одним запросом проверьте, в какие ваши зоны попадает каждая точка — полигональные или круговые ограждения.
/api/1/geofenceПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| fences | array | Обязательный | [] | Массив ограждений: { id?, polygon:[[lat,lng],...] } или { id?, center:[lat,lng], radius_m }. До 100. |
| points | array | Обязательный | [] | Массив точек [lat,lng] для проверки (до 1000). |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/geofence" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"fences":[{"id":"zone1","polygon":[[40.40,49.85],[40.43,49.85],[40.43,49.90],[40.40,49.90]]}],"points":[[40.41,49.87],[40.50,50.10]]}'Лимиты и координаты
Стоимость в кредитах: 1 credit / 100 points
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- fences: 1–100
- points: 1–1000
- credits = max(1, ceil(points / 100))
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"results": [
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"inside": [
"depot"
]
}
],
"count": 1,
"took": 1
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Body must include non-empty \"fences\" and \"points\" arrays."
}Исправьте отсутствующие или неверные параметры.
{
"error": "Limits: up to 100 fences and 1000 points per request."
}Пояснение структуры ответа
Возвращает { results[], count }. Каждый результат — { point:{lat,lng}, inside:[fenceId,...] } со всеми ограждениями, в которые попала точка (пусто, если нет).
Elevation Profile API
#Высота в каждой точке пути + общий подъём, спуск и расстояние — полный профиль маршрута.
/api/1/elevation/profileПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| points | array | Необязательный | [] | Массив точек [lat,lng] пути (>=2, до 2000). |
| polyline | string | Необязательный | - | Закодированная полилиния вместо points. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/elevation/profile" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"points":[[40.37,49.85],[40.80,48.90],[41.30,48.05]]}'Лимиты и координаты
Стоимость в кредитах: 1 credit / 10 points
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- points: 2–2000
- credits = max(1, ceil(points / 10))
- elevation: number | null
Высота может быть null при отсутствии данных. Не заменяйте неизвестную высоту нулём.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"profile": [
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"elevation": null,
"distance": 0
},
{
"point": {
"lat": 40.4,
"lng": 49.86
},
"elevation": null,
"distance": 2590
}
],
"total_ascent": 0,
"total_descent": 0,
"min_elevation": null,
"max_elevation": null,
"distance": 2590,
"unit": "meters",
"took": 12
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide a \"points\" array (>=2 [lat,lng]) or an encoded \"polyline\"."
}Исправьте отсутствующие или неверные параметры.
{
"error": "A maximum of 2000 points is allowed per request."
}Пояснение структуры ответа
Возвращает { profile[], total_ascent, total_descent, min_elevation, max_elevation, distance, unit }. Каждый элемент — { point, elevation, distance } (метры).
Solar API
#Восход, закат, сумерки, солнечный полдень и длина дня для любой координаты и даты.
/api/1/solarПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | lat,lng | Координата: lat,lng. |
| date | string | Необязательный | today | Дата (YYYY-MM-DD) для расчёта; по умолчанию сегодня. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/solar?point=40.4093,49.8671&date=2026-07-07" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- date: YYYY-MM-DD; default = today
- times: UTC ISO 8601 | null
Во время полярного дня или ночи время может быть null. Время указано в UTC.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"date": "2026-01-01",
"sunrise": "2026-01-01T04:00:00.000Z",
"sunset": "2026-01-01T13:00:00.000Z",
"solar_noon": "2026-01-01T08:30:00.000Z",
"day_length_seconds": 32400
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Пояснение структуры ответа
Возвращает { point, date, sunrise, sunset, solar_noon, dawn, dusk, golden_hour, night_start, night_end, day_length_seconds }. Время в UTC ISO; null в полярный день/ночь.
Geometry Utilities API
#Расстояние, азимут, площадь, центроид, упрощение и polyline encode/decode — геометрия как сервис.
/api/1/geometryПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| op | string | Обязательный | distance | Операция: distance, bearing, destination, midpoint, length, area, centroid, simplify, polyline_encode или polyline_decode. |
| from | array | Необязательный | [lat,lng] | Начальная точка [lat,lng]. |
| to | array | Необязательный | [lat,lng] | Конечная точка [lat,lng]. |
| path | array | Необязательный | [] | Массив [lat,lng] (length/simplify/polyline_encode). |
| polygon | array | Необязательный | [] | Кольцо [lat,lng] (area). |
distance, bearing, midpoint → from, to
destination → from, bearing (°), distance_m
length → path (≥ 2)
area → polygon (≥ 3)
centroid → points (≥ 1)
simplify → path (2–2000), tolerance_m (10)
polyline_encode → path (≥ 1), precision (5)
polyline_decode → polyline, precision (5)Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/geometry" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"op":"distance","from":[40.37,49.85],"to":[40.40,49.86]}'Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- op: distance | bearing | destination | midpoint | length | area | centroid | simplify | polyline_encode | polyline_decode
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"op": "distance",
"distance": 2590.25,
"unit": "meters"
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Invalid geometry input for the requested op."
}Пояснение структуры ответа
Возвращает { op, ... } с результатом операции, напр. { distance, unit }, { bearing_deg }, { point }, { area, unit }, { path } или { polyline }.
Coordinate Conversion API
#Преобразование широты/долготы в UTM и MGRS и обратно.
/api/1/convertПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Необязательный | lat,lng | Координата lat,lng для конвертации в UTM/MGRS. |
| mgrs | string | Необязательный | - | Строка MGRS для обратной конвертации в координату. |
Передайте point=lat,lng, пару lat и lon либо mgrs. Непустой mgrs имеет приоритет. Обратное преобразование возвращает центр ячейки MGRS без поля utm.
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/convert?point=40.3755,49.8516" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- point=lat,lng OR (lat=... AND lon=...) OR mgrs=...
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"point": {
"lat": 40.3755,
"lng": 49.8516
},
"mgrs": "39TVE0251070068",
"utm": {
"zone": 39,
"band": "T",
"easting": 402511,
"northing": 4470068,
"hemisphere": "N"
}
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide point=lat,lng (or lat= & lon=), or mgrs= to reverse-convert."
}Пояснение структуры ответа
Возвращает { point, mgrs, utm:{ zone, band, easting, northing, hemisphere } }. При mgrs= — { mgrs, point }.
Country Info API
#Валюта, телефонный код, языки, столица и флаг любой страны по ISO-коду или названию.
/api/1/countryПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| code | string | Необязательный | AZ | Код страны ISO 3166 alpha-2 или alpha-3 (напр. AZ или AZE). |
| name | string | Необязательный | - | Название страны вместо кода. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/country?code=AZ" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 1 credit
См. именованные поля JSON; запрос не требует пары координат.
- code=ISO2/ISO3 OR name=...
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"name": "Azerbaijan",
"official_name": "Republic of Azerbaijan",
"cca2": "AZ",
"cca3": "AZE",
"capital": "Baku",
"region": "Asia",
"subregion": "Western Asia",
"currency": {
"code": "AZN",
"name": "Azerbaijani manat",
"symbol": "₼"
},
"calling_code": "+994",
"languages": [
"Azerbaijani"
],
"flag": "🇦🇿",
"latlng": [
40.5,
47.5
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide code=ISO2/ISO3 or name=CountryName."
}Используйте верный код или точное имя страны.
{
"error": "Country not found."
}Пояснение структуры ответа
Возвращает { name, official_name, cca2, cca3, capital, region, subregion, currency:{code,name,symbol}, calling_code, languages[], flag, latlng }.
Isochrone API
#Оценивает доступность по времени поездки до выборочных точек. Если в каждом направлении есть достижимая точка, quality.status равен estimated; иначе возвращаются insufficient_data и пустой polygons. Пустой результат не доказывает отсутствие доступных дорог. Граница приблизительна; поддерживается только ограничение времени.
/api/1/isochroneПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| point | string | Обязательный | - | Центральная точка. Формат: lat,lon. |
| time_limit | integer | Необязательный | 600 | Лимит времени в пути (в секундах). |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl "https://osrmroute.com/api/1/isochrone?point=40.4093,49.8671&time_limit=600" -H "Authorization: Bearer YOUR_KEY"Лимиты и координаты
Стоимость в кредитах: 2 credits / minute; minimum 10
point=lat,lng; массивы JSON: [lat,lng]. Геометрия GeoJSON: [lon,lat].
- time_limit: min = 60 s
- time_limit ≤ plan.maxIsochroneMinutes × 60
- quality.status = estimated | insufficient_data; polygons = [] when any bearing lacks a reachable sample
- Sampled OSRM estimate, not an exact reachable-area boundary; an empty polygon does not prove no reachable roads
- credits = max(10, ceil(time_limit_seconds / 30))
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"quality": {
"status": "estimated",
"method": "sampled_osrm",
"sampled_points": 80,
"reachable_points": 48,
"covered_bearings": 16,
"total_bearings": 16,
"unknown_points": 0
},
"polygons": [
{
"type": "Feature",
"properties": {
"bucket": 0,
"time_limit": 600
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
49.84,
40.37
],
[
49.87,
40.37
],
[
49.87,
40.4
],
[
49.84,
40.37
]
]
]
}
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "point parameter is required"
}Проверьте лимиты сложности и ограничения ключа в кабинете.
{
"error": "The Isochrone API is not available on your plan. Upgrade your plan to use it."
}Выберите поддерживаемый профиль. Автоматического перехода на автомобильный нет.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Сервис или источник недоступен. Повторяйте осторожно с увеличением паузы.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Пояснение структуры ответа
polygons[] — GeoJSON Feature; geometry — Polygon [lon,lat]; properties.time_limit — предел времени (с).
Route Optimization API
#Планирует маршруты с ограничениями вместимости, временных окон, навыков и связанных операций забора/доставки. Эвристика с ограничением времени сокращает поездки, но не гарантирует глобальный оптимум. Неназначенные задания остаются в solution.unassigned; некорректный ввод отклоняется целиком.
/api/1/vrpПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| vehicles | array | Необязательный | one default vehicle | Список транспортных средств — у каждого id, необязательная вместимость и начальная точка в виде массива [lon, lat] (сначала долгота). |
| services | array | Необязательный | [] | Точки для обслуживания — у каждой id, координаты в виде массива [lon, lat] (сначала долгота) и необязательное время обслуживания. |
| shipments | array | Необязательный | [] | Связанные задания забора и доставки с amount и skills. Укажите services, shipments или оба списка; максимум 250 точек заданий. |
| profile | string | Необязательный | driving | Общий профиль: driving, cycling или walking, включая документированные альтернативные имена. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/vrp" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"vehicles":[{"vehicle_id":"v1","start":[49.85,40.37]}],"services":[{"id":10,"location":[49.86,40.40]}]}'Лимиты и координаты
Стоимость в кредитах: max(10, ceil(vehicles * task_points * 13 / 15)) credits
Массивы VRP start/location: [lon,lat]; объекты: lat и lng/lon. Время в секундах.
- vehicles.length ≤ plan.maxVehicles
- vehicles defaults to one vehicle when omitted
- services.length + 2 × shipments.length ≤ 250; vehicles.length ≤ 100
- task_points = services.length + 2 × shipments.length
- credits = max(10, ceil(vehicles * task_points * 13 / 15)); invalid inputs are refunded
- Capacity arrays, time_windows, skills and paired shipments are enforced; unsupported options return 400
- solution.unassigned lists tasks not assigned by the bounded heuristic; this is not proof of infeasibility
- transport_time is travel only; service_time, waiting_time and elapsed time are separate; costs is travel seconds
Автомобильные, пешеходные и велосипедные маршруты доступны по всему миру. Нужны связанные пути с разрешённым доступом. VRP использует эвристики, изохроны приблизительны; глобальный оптимум и живой трафик не обещаются.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"status": "finished",
"job_id": "opt-1234567890",
"processing_time": 0,
"solution": {
"unassigned": [],
"quality": {
"solver": "vroom",
"version": "1.15.0",
"constraints_verified": true,
"optimality_proven": false
},
"costs": 420,
"distance": 3200,
"time": 420,
"no_vehicles": 1,
"no_unassigned": 0,
"routes": [
{
"vehicle_id": "v1",
"distance": 3200,
"transport_time": 420,
"activities": [
{
"type": "start",
"location_id": "depot",
"end_time": 0
},
{
"type": "service",
"id": 10,
"location_id": "stop_1",
"arr_time": 200,
"end_time": 200
},
{
"type": "end",
"location_id": "depot",
"arr_time": 420
}
]
}
]
}
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"code": "InvalidOptimizationInput",
"error": "At least one service with valid coordinates is required."
}Проверьте лимиты сложности и ограничения ключа в кабинете.
{
"error": "Your plan allows up to 1 vehicles per request. Upgrade your plan for more."
}Проверьте, что точки расположены рядом с доступными дорогами и дороги соединены для выбранного профиля.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Пояснение структуры ответа
status → finished; job_id — ID задания; solution: distance — расстояние (м), time и costs — время (с), no_vehicles, no_unassigned — количества, routes[] — маршруты. routes[]: vehicle_id, distance (м), transport_time (с), activities[] — действия.
Location Clustering API
#Группирует заданные координаты по их географической близости и плотности (разбивает на кластеры).
/api/1/clusterПараметры (Query Params)
| Параметр | Тип | Статус | По умолчанию | Описание |
|---|---|---|---|---|
| customers | array | Обязательный | [] | Координаты клиентов и веса для кластеризации. |
Пример запроса
Замените YOUR_KEY своим API-ключом. API-запросы расходуют кредиты; копирование примера не отправляет запрос.
curl -X POST "https://osrmroute.com/api/1/cluster" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"customers":[[49.85,40.37],[49.86,40.40],[49.83,40.39]],"clusters":2}'Лимиты и координаты
Стоимость в кредитах: 3 credits
Координаты клиентов на входе: [lon,lat]; center на выходе: [lat,lon].
- customers: valid coordinates ≥ 1
- 1 ≤ clusters ≤ valid_customers.length
Проверяйте формат ввода и единицы полей в примере.
Текущие тарифы и ценыПокрытие по сервисамПример JSON-ответа
Сокращённый пример JSON. Значения, необязательные поля и картографические данные могут отличаться. Расстояния указаны в метрах, время маршрута — в секундах, если не указано иначе.
{
"status": "finished",
"job_id": "cluster-1234567890",
"processing_time": 0,
"no_clusters": 1,
"clusters": [
{
"ids": [
"s1",
"s2"
],
"center": [
40.385,
49.855
],
"size": 2
}
]
}Ошибки сервиса
Исправьте отсутствующие или неверные параметры.
{
"error": "Provide a \"customers\" array with valid coordinates."
}Пояснение структуры ответа
status → finished; job_id — ID задания; no_clusters — число кластеров; clusters[]: ids[] — элементы, center [lat,lon] — центр, size — размер.
Эндпоинты совместимости
Перед переходом на основной API проверьте порядок координат и единицы в ответе.
Короткий URL Routing использует те же входные данные и ответ, что OSRM. Старый Route принимает повторяющиеся пары широта,долгота. paths[].time указан в миллисекундах, paths[].distance в метрах. Route info описывает настроенное покрытие и стоит один кредит.
GET /api/v1/route/driving/49.8516,40.3755;49.8378,40.3892
GET /api/1/route?point=40.3755,49.8516&point=40.3892,49.8378
GET /api/1/route/infoСтарый Matrix принимает повторяющиеся point либо списки from_point и to_point. В JSON передайте from_points и to_points как пары широта,долгота. Время в миллисекундах, расстояние в метрах.
GET /api/1/matrix?point=40.3755,49.8516&point=40.3892,49.8378{"from_points":[[40.3755,49.8516]],"to_points":[[40.3892,49.8378]]}Старый Match принимает GPS-трек в виде упорядоченных пар [lon, lat]. Для каждой точки можно передать время в секундах и радиус в метрах. Ответ содержит расстояния в метрах и время в миллисекундах. Пакетный Elevation ([lat, lon]) принимает до 1 000 пар и возвращает высоты в метрах или null.
{"points":[[49.8516,40.3755],[49.8378,40.3892]],"timestamps":[1760000000,1760000120],"radiuses":[20,20]}{"points":[[40.3755,49.8516],[40.3892,49.8378]]}optimize и vrp/optimize используют формат VRP. Псевдонимы кластеризации и пакетного геокодирования используют основные форматы. VRP и кластеризация возвращают результат прямо в ответе.
POST /api/1/optimize·POST /api/1/vrp/optimize→ Route Optimization APIPOST /api/1/cluster/calculate→ Location Clustering APIPOST /api/1/batch-geocode→ Batch Geocoding API
Официальные SDK
Kotlin для Android/JVM и Swift для iOS. Типизированные модели и асинхронные запросы к географическим API OSRMRoute.