Documentation API, SDK et guides d’intégration
Consultez les points d’accès API, l’authentification, les limites et les exemples pour les SDK mobiles, CLI, MCP, styles de carte, lieux et données routières.
Catalogue des API
Trouvez une API par nom, usage ou endpoint. Chaque lien mène aux paramètres, aux exemples et aux limites d’utilisation.
Navigation (10)
- Routing API →
Calculez un itinéraire qui passe par les points dans l’ordre fourni, en voiture, à vélo ou à pied. Utilisez steps=true pour les instructions et geometries=geojson pour le GeoJSON.
GET /api/v1/osrm/route/v1/{profile}/{coordinates} - Isochrones API →
Estime l’accessibilité à partir des temps de trajet vers des points échantillonnés. Si chaque direction contient un point accessible, quality.status vaut estimated ; sinon il vaut insufficient_data et polygons est vide. Un résultat vide ne prouve pas l’absence de routes accessibles. La limite est approximative ; seules les limites de temps sont prises en charge.
GET /api/1/isochrone - Map Matching API →
Aligne des traces GPS imprécises sur le réseau routier réel (snap to road). Utilisé pour nettoyer le bruit dans les signaux GPS.
GET /api/v1/osrm/match/v1/{profile}/{coordinates} - Nearest API →
Aligne n'importe quelle coordonnée sur le segment de route réel le plus proche (snap) et renvoie des informations sur le nom de la route.
GET /api/v1/osrm/nearest/v1/{profile}/{coordinates} - Directions API →
Renvoie une navigation détaillée entre deux points ou plus avec une liste d’instructions claire (texte, distance, durée, type de manœuvre et position). Prend en charge voiture, vélo et à pied, ainsi que jusqu’à 3 itinéraires alternatifs en un seul appel.
GET /api/1/directions - Alternative Routes API →
Renvoie une navigation détaillée entre deux points ou plus avec une liste d’instructions claire (texte, distance, durée, type de manœuvre et position). Prend en charge voiture, vélo et à pied, ainsi que jusqu’à 3 itinéraires alternatifs en un seul appel.
GET /api/1/directions - Snap to Road API →
Aligne des points GPS bruts et imprécis sur la position la plus proche du réseau routier. Répétez le paramètre point pour chaque coordonnée (jusqu’à 100).
GET /api/1/snap - API estimation de carburant →
Estimez le carburant et sa valeur avec distance, poids chargé, consommations à vide/pleine charge et prix au litre. Seule ou dans Truck.
POST /api/v1/fuel/estimate - Truck Routing API →
Planifiez des trajets en camion dans un pays ou au-delà des frontières sur des routes reliées. Envoyez les dimensions et le poids du véhicule chargé à chaque requête.
POST /api/v1/truck/route - Search Along Route API →
Comparez les arrêts et le temps de conduite supplémentaire sur un itinéraire.
POST /api/v1/places/along-route
Opérations et planification du chargement (7)
- Route Optimization API →
Planifie les tournées avec des contraintes de capacité, créneaux horaires, compétences et enlèvements/livraisons liés. Une heuristique à durée limitée réduit le trajet sans garantir un optimum global. Les tâches non affectées restent dans solution.unassigned ; les entrées invalides sont rejetées intégralement.
POST /api/1/vrp - Matrix API →
Calculez les durées, les distances ou les deux entre les points de départ et d’arrivée. Sélectionnez les indices de la liste avec sources et destinations.
GET /api/v1/osrm/table/v1/{profile}/{coordinates} - Trip API (TSP) →
Ordonnez les arrêts d’un seul véhicule sur le réseau routier. Pour un trajet ouvert, envoyez roundtrip=false&source=first&destination=last. L’ordre obtenu peut être sous-optimal.
GET /api/v1/osrm/trip/v1/{profile}/{coordinates} - Clustering de lieux →
Regroupe (en clusters) les coordonnées données selon leur proximité et leur densité géographique.
POST /api/1/cluster - Planification du chargement →
Planifiez des chargements mixtes pour camions et conteneurs. Vérifiez l’empilage, l’ordre de chargement et l’espace en 3D ou intégrez l’API à votre système.
POST /api/v1/load-plansGET /api/v1/load-plansGET /api/v1/load-plans/{id}Tous les endpoints (+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 - Analyse de trajet : preuve de visite →
Preuve de visite et d'arrêt issue de votre trace.
POST /api/v1/trip-analytics/visit-proof - Optimisation de flotte de camions →
Matrices camion statiques spécifiques au véhicule.
POST /api/v1/truck/optimize
Recherche (8)
- Geocoding API →
Convertit un texte de recherche en coordonnées géographiques (directe) ou des coordonnées en adresse (inverse). Autocomplétion rapide et tolérante aux fautes de frappe couvrant rues, adresses et points d’intérêt (cafés, magasins, hôtels, bureaux). Idéal pour la recherche au fil de la saisie.
GET /api/1/geocode - Places API →
Trouvez des points d’intérêt près d’un lieu — cafés, magasins, hôtels, distributeurs, pharmacies, etc. — filtrés par catégorie et rayon, triés par distance.
GET /api/1/places - Autocomplete API →
Suggestions de lieux rapides et tolérantes aux fautes pendant la saisie, avec pondération géographique.
GET /api/1/autocomplete - Batch Geocoding API →
Géocodez jusqu’à 100 adresses par requête. Les résultats suivent l’ordre de saisie et chaque adresse coûte un crédit.
POST /api/1/geocode/batch - Recherche en langage naturel →
Trouvez des lieux avec une courte requête en anglais.
POST /api/v1/search/natural - Détails des lieux →
Consultez les attributs fournis par la source.
POST /api/v1/places/details - Structured Geocoding API →
Recherchez une adresse par rue, ville, code postal et pays.
POST /api/v1/search/structured - Suggest & Retrieve API →
Créez une recherche de lieux avec suggestions et récupération sécurisée.
POST /api/v1/search/suggestPOST /api/v1/search/retrieve
Cartes (4)
- Aperçu du style par texte →
Décrivez les couleurs et calques, puis vérifiez le résultat.
POST /api/v1/studio/preview - Static Maps API →
Exportez des cartes stylisées en PNG pour vos rapports et applications.
POST /api/v1/maps/static - Studio API →
Gérez styles, jeux de données et publication depuis votre application.
GET /api/v1/studio/{resource}POST /api/v1/studio/{resource} - Styles de carte et tuiles vectorielles →
Chargez des fonds publics ou des styles publiés dans MapLibre. Les requêtes publiques ne demandent aucune clé et ne consomment aucun crédit. Utilisez les URL de tuiles du style et conservez l’attribution.
GET /api/basemaps/{style}GET /api/map-styles/{id}GET /api/map-styles/{id}/tiles/{dataset}/{z}/{x}/{y}Tous les endpoints (+2)
GET /api/private-maps/{id}GET /api/private-maps/{id}/tiles/{dataset}/{z}/{x}/{y}
Données (15)
- Timezone API →
Fuseau horaire IANA, décalage UTC actuel, statut de l’heure d’été et heure locale pour toute coordonnée.
GET /api/1/timezone - Elevation API →
Altitude au-dessus du niveau de la mer, en mètres, pour toute coordonnée — un point ou le profil d’un itinéraire entier.
GET /api/1/elevation - Boundary Lookup API →
Trouvez dans quel pays, région, ville et quartier se trouve une coordonnée — avec le polygone de la limite sur demande.
GET /api/1/boundary - Geofencing API →
Vérifiez en un appel dans lesquelles de vos zones tombe chaque point — clôtures polygonales ou circulaires.
POST /api/1/geofence - Elevation Profile API →
Altitude en chaque point d’un trajet plus dénivelé positif, négatif et distance — un profil complet.
POST /api/1/elevation/profile - Solar API →
Lever, coucher, crépuscule, midi solaire et durée du jour pour toute coordonnée et date.
GET /api/1/solar - Geometry Utilities API →
Distance, cap, aire, centroïde, simplification et polyline encode/decode — la géométrie en service.
POST /api/1/geometry - Coordinate Conversion API →
Convertit latitude/longitude vers et depuis les références de grille UTM et MGRS.
GET /api/1/convert - Country Info API →
Devise, indicatif, langues, capitale et drapeau de tout pays par code ISO ou nom.
GET /api/1/country - Dataset Query API →
Trouvez des objets proches dans vos propres jeux de données géographiques.
POST /api/v1/maps/datasets/{id}/query - API de données routières →
Limitations de vitesse, attributs routiers et observations de panneaux selon la couverture disponible.
POST /api/v1/roads/lookupPOST /api/v1/roads/batch - Utilisation du compte →
Données routières : 100 000 opérations par mois
POST /api/v1/roads/usage - API de signalisation routière →
Trouvez des observations de panneaux dans une zone de la carte. Obtenez leur classification, leurs coordonnées, leur direction et leurs dates avec pagination par curseur.
POST /api/v1/roads/signs - Preuve de conformité d'itinéraire →
Preuve de vitesse qualifiée par source pour positions soumises.
POST /api/v1/roads/compliance - Limite de vitesse routière →
Consultez la limite de vitesse cartographiée pour les voitures près d’une coordonnée. Une valeur manquante ou ambiguë renvoie null.
GET /api/1/speed-limit
Guide d’intégration de la plateforme (6)
- Tâches asynchrones →
Opérations : geocode_batch, matrix, optimize. POST /api/jobs renvoie 202 et un identifiant de tâche. Le même Idempotency-Key et le même contenu renvoient la tâche existante ; un contenu différent renvoie 409.
POST /api/jobsGET /api/jobsGET /api/jobs/{id}Tous les endpoints (+1)
DELETE /api/jobs/{id} - API Sandbox →
Validez l’analyse des réponses dans le sandbox à données de test avant un appel réel payant.
POST /api/sandbox - Métadonnées des sources →
Consultez les sources, la couverture géographique et la fraîcheur des données par service.
GET /api/source-metadata - Accès mobile →
Connectez votre application sans intégrer de clé API secrète.
POST /api/mobile/challengePOST /api/mobile/token - API MCP distante →
Connectez vos outils IA aux services de localisation.
POST /api/mcp - Endpoints de compatibilité →
Avant de migrer une intégration, vérifiez l’ordre des coordonnées et les unités de réponse.
GET /api/v1/route/{profile}/{coordinates}GET /api/1/routeGET /api/1/route/infoTous les endpoints (+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
Introduction
#OSRMRoute fournit des API d’itinéraires, de planification de flotte, de recherche d’adresses, de cartographie et de données géographiques. Le catalogue mène au guide de l’opération à intégrer.
Limites actuelles des offres
Les limites de crédits et de requêtes par minute sont partagées entre toutes les clés du compte. Un plafond supplémentaire par clé ne les augmente pas. Les crédits inclus sont utilisés avant les crédits achetés.
Free inclut les API Routing, Route Optimization, Geocoding (avec recherche inverse et autocomplétion) et Matrix dans les limites du forfait. Map Matching, Isochrone, Truck Routing, Fuel Estimate et les autres API distinctes nécessitent un forfait payant, y compris PAYG. L’accès aux API dépend du forfait effectif du compte ; un solde positif ne supprime pas à lui seul les restrictions Free. Les données routières et AI conservent leurs conditions Business distinctes.
Route, Directions et Truck Routing : une requête traitée sans route accessible à proximité ou sans itinéraire connecté coûte une seule fois 0,5 crédit sur tous les forfaits éligibles, y compris PAYG. Les erreurs de saisie, refus d’accès/de forfait ou de couverture du graphe et erreurs serveur ne sont pas facturés. Le prix d’une requête réussie est réservé ; le solde est rendu.
Chargement des limites…
La démo publique prend en charge Route, Matrix, Match, Nearest et Trip avec ses propres limites. Pour les autres services, utilisez votre clé API et les exemples ci-dessous.
Authentification
#Envoyez la clé sous forme de jeton Bearer dans l’en-tête Authorization. Consultez le guide pour connaître la portée de la clé et l’environnement requis. Certains anciens endpoints acceptent les clés en paramètre d’URL.
Authorization: Bearer YOUR_API_KEYCodes d'erreur
#OSRMRoute utilise des codes de statut HTTP standard et des messages d'erreur JSON détaillés pour indiquer l'état d'une requête.
Les erreurs contiennent error et parfois code. Vérifiez le statut HTTP et les en-têtes de budget, pas seulement le texte. Reset décrit des fenêtres glissantes, pas une remise à zéro à minuit.
X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Compute-* · X-Quota-* · X-Credits-* · Retry-AfterFournissez une clé API valide et vérifiez son statut.
{
"error": "Invalid API Key"
}Rechargez le solde ou choisissez une offre adaptée.
{
"error": "Insufficient balance: this request costs 1 credit and your balance is 0 credits. Top up your account to continue."
}Vérifiez les limites de complexité et les restrictions de la clé.
{
"error": "This API Key is disabled"
}Respectez Retry-After et réduisez la fréquence des requêtes.
{
"error": "Rate limit exceeded: this account has exceeded its configured requests-per-minute limit. Please slow down."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"error": "Internal Server Error"
}Routing API
#Calculez un itinéraire qui passe par les points dans l’ordre fourni, en voiture, à vélo ou à pied. Utilisez steps=true pour les instructions et geometries=geojson pour le GeoJSON.
/api/v1/osrm/route/v1/{profile}/{coordinates}Paramètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| profile | string | Obligatoire | driving | Profil du mode de transport. Valeurs prises en charge : driving (voiture), cycling (vélo), walking (piéton). |
| coordinates | string | Obligatoire | - | Coordonnées des points. Format : lon,lat;lon,lat;lon,lat... (au moins 2 points). |
| overview | string | Facultatif | simplified | Niveau de détail de la géométrie d'itinéraire renvoyée : simplified (simplifiée), full (géométrie complète), false (sans géométrie). |
| geometries | string | Facultatif | polyline | Format de géométrie : geojson (objet GeoJSON), polyline (chaîne encodée). |
| steps | boolean | Facultatif | false | Si des instructions étape par étape sont renvoyées pour chaque virage. |
| alternatives | integer | boolean | Facultatif | false | Nombre d’alternatives à rechercher. Leur disponibilité dépend du réseau routier. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"Limites et coordonnées
Coût en crédits: 1 crédit par tranche entamée de 10 points fournis, départ et arrivée compris.
Route, Directions et Truck Routing : une requête traitée sans route accessible à proximité ou sans itinéraire connecté coûte une seule fois 0,5 crédit sur tous les forfaits éligibles, y compris PAYG. Les erreurs de saisie, refus d’accès/de forfait ou de couverture du graphe et erreurs serveur ne sont pas facturés. Le prix d’une requête réussie est réservé ; le solde est rendu.
Chemin OSRM : lon,lat ; GeoJSON : [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- snap_distance_m ≤ 2000
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}L’API n’a pas pu traiter tous les points sur un même réseau routier pour le profil choisi. Envoyez les tronçons connectés séparément.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
La distance est en mètres et la durée en secondes. La ligne est simplifiée et encodée en polyline par défaut. Utilisez overview=full pour obtenir la ligne complète.
Matrix API
#Calculez les durées, les distances ou les deux entre les points de départ et d’arrivée. Sélectionnez les indices de la liste avec sources et destinations.
/api/v1/osrm/table/v1/{profile}/{coordinates}Paramètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| profile | string | Obligatoire | driving | Profil de transport (driving, cycling, walking). |
| coordinates | string | Obligatoire | - | Points de la matrice. Format : lon,lat;lon,lat;lon,lat... |
| annotations | string | Facultatif | duration | Données à calculer : duration (temps), distance ou les deux. |
| sources | string | Facultatif | all | Indices de départ à partir de zéro, séparés par des points-virgules, ou all. |
| destinations | string | Facultatif | all | Indices d’arrivée à partir de zéro, séparés par des points-virgules, ou all. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"Limites et coordonnées
Coût en crédits: max(1, ceil(cells * 2 / 5))
Chemin OSRM : lon,lat ; GeoJSON : [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- cells = sources × destinations
- credits = max(1, ceil(cells * 2 / 5))
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}L’API n’a pas pu traiter tous les points sur un même réseau routier pour le profil choisi. Envoyez les tronçons connectés séparément.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "UnreachablePoints",
"error": "Some locations are disconnected in this road network."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
La matrice durations est renvoyée par défaut. Utilisez annotations=distance pour les distances ou annotations=duration,distance pour les deux. Les durées sont en secondes et les distances en mètres. Si aucun graphe admissible ne peut compléter la matrice, les points déconnectés donnent HTTP 422 UnreachablePoints.
Map Matching API
#Aligne des traces GPS imprécises sur le réseau routier réel (snap to road). Utilisé pour nettoyer le bruit dans les signaux GPS.
/api/v1/osrm/match/v1/{profile}/{coordinates}Paramètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| geometries | string | Facultatif | polyline | Format de géométrie : geojson (objet GeoJSON), polyline (chaîne encodée). |
| profile | string | Obligatoire | driving | Profil de transport. |
| coordinates | string | Obligatoire | - | La séquence de coordonnées GPS à aligner (lon,lat;lon,lat...) |
| overview | string | Facultatif | simplified | Précision de la géométrie de l'itinéraire aligné. |
| timestamps | string | Facultatif | - | Horodatages Unix en secondes, dans l’ordre non décroissant, un par point, séparés par des points-virgules. |
| radiuses | string | Facultatif | - | Précision GPS en mètres, une valeur par point, séparée par des points-virgules. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"Limites et coordonnées
Coût en crédits: 1 credit
Chemin OSRM : lon,lat ; GeoJSON : [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- tracepoints[]: object | null
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}L’API n’a pas pu traiter tous les points sur un même réseau routier pour le profil choisi. Envoyez les tronçons connectés séparément.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
matchings[] : distance — distance (m), duration — durée (s), confidence — confiance (0–1), geometry — géométrie ; tracepoints[] — objet ou null.
Nearest API
#Aligne n'importe quelle coordonnée sur le segment de route réel le plus proche (snap) et renvoie des informations sur le nom de la route.
/api/v1/osrm/nearest/v1/{profile}/{coordinates}Paramètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| profile | string | Obligatoire | driving | Profil de transport. |
| coordinates | string | Obligatoire | - | Le point à proximité duquel chercher. Format : lon,lat (une seule paire). |
| number | integer | Facultatif | 1 | Le nombre de routes candidates les plus proches à trouver. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/v1/osrm/nearest/v1/driving/49.8516,40.3777?number=3" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
Chemin OSRM : lon,lat ; GeoJSON : [lon,lat].
- coordinates: 1
- number: default = 1; example = 3
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"code": "Ok",
"waypoints": [
{
"name": "Example road",
"location": [
49.8516,
40.3777
],
"distance": 4.2
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
waypoints[] → name, distance (m), location [lon,lat].
Trip API
#Ordonnez les arrêts d’un seul véhicule sur le réseau routier. Pour un trajet ouvert, envoyez roundtrip=false&source=first&destination=last. L’ordre obtenu peut être sous-optimal.
/api/v1/osrm/trip/v1/{profile}/{coordinates}Paramètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| geometries | string | Facultatif | polyline | Format de géométrie : geojson (objet GeoJSON), polyline (chaîne encodée). |
| profile | string | Obligatoire | driving | Profil de transport. |
| coordinates | string | Obligatoire | - | Points à visiter. Format : lon,lat;lon,lat... |
| source | string | Facultatif | any | Le point où l'itinéraire peut commencer (any ou le premier point). |
| destination | string | Facultatif | any | Le point où l'itinéraire se termine (any ou le dernier point). |
| roundtrip | boolean | Facultatif | true | Revenir au départ. Pour false, utiliser source=first et destination=last. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"Limites et coordonnées
Coût en crédits: 5 credits
Chemin OSRM : lon,lat ; GeoJSON : [lon,lat].
- points ≥ 2; points ≤ plan.maxRoutePoints
- credits = 5
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidQuery",
"error": "Coordinates must be finite longitude,latitude pairs."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}L’API n’a pas pu traiter tous les points sur un même réseau routier pour le profil choisi. Envoyez les tronçons connectés séparément.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
trips[] : distance — distance (m), duration — durée (s), geometry — géométrie ; waypoints[] : trips_index, waypoint_index — indices d’ordre, location [lon,lat] — coordonnées.
Directions API
#Renvoie une navigation détaillée entre deux points ou plus avec une liste d’instructions claire (texte, distance, durée, type de manœuvre et position). Prend en charge voiture, vélo et à pied, ainsi que jusqu’à 3 itinéraires alternatifs en un seul appel.
/api/1/directionsParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Point au format lat,lng. Répétez le paramètre pour chaque arrêt (minimum 2). |
| profile | string | Facultatif | driving | Mode de déplacement : driving, cycling ou walking. |
| alternatives | integer | Facultatif | 0 | Nombre d’itinéraires alternatifs supplémentaires à renvoyer (0–3). |
| lang | string | Facultatif | en | Code de langue du texte des instructions. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"Limites et coordonnées
Coût en crédits: 1 crédit par tranche entamée de 10 points fournis, départ et arrivée compris.
Route, Directions et Truck Routing : une requête traitée sans route accessible à proximité ou sans itinéraire connecté coûte une seule fois 0,5 crédit sur tous les forfaits éligibles, y compris PAYG. Les erreurs de saisie, refus d’accès/de forfait ou de couverture du graphe et erreurs serveur ne sont pas facturés. Le prix d’une requête réussie est réservé ; le solde est rendu.
Entrée point=lat,lng. Instructions et étapes : [lat,lng] ; GeoJSON : [lon,lat].
- point: repeat ≥ 2; count ≤ plan.maxRoutePoints
- alternatives: 0–3
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
]
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "At least two points must be provided (point=lat,lng repeated)."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}L’API n’a pas pu traiter tous les points sur un même réseau routier pour le profil choisi. Envoyez les tronçons connectés séparément.
{
"code": "CrossRegionNotSupported",
"error": "These coordinates are not served by one routing graph. Split the request by region."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
Renvoie { code, profile, routes[], waypoints[] }. Chaque itinéraire a distance (m), duration (s), une géométrie GeoJSON et un tableau instructions[] ; chaque instruction inclut text, type, modifier, distance, duration, name et location [lat,lng].
Snap to Road API
#Aligne des points GPS bruts et imprécis sur la position la plus proche du réseau routier. Répétez le paramètre point pour chaque coordonnée (jusqu’à 100).
/api/1/snapParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Point GPS au format lat,lng. Répétez le paramètre pour chaque point (maximum 100). |
| profile | string | Facultatif | driving | Réseau routier cible : driving, cycling ou walking. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/snap?point=40.3778,49.8517&point=40.3801,49.8600" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- point: repeat 1–100
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"code": "Ok",
"profile": "driving",
"snapped": [
{
"input": [
40.3777,
49.8516
],
"snapped": [
40.3778,
49.8517
],
"distance": 14,
"name": "Example road"
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "At least one point must be provided (point=lat,lng repeated)."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
Renvoie { code, profile, snapped[] }. Chaque élément contient l’input d’origine [lat,lng], la position alignée [lat,lng], la distance d’alignement en mètres et le nom de la voie.
Geocoding API
#Convertit un texte de recherche en coordonnées géographiques (directe) ou des coordonnées en adresse (inverse). Autocomplétion rapide et tolérante aux fautes de frappe couvrant rues, adresses et points d’intérêt (cafés, magasins, hôtels, bureaux). Idéal pour la recherche au fil de la saisie.
/api/1/geocodeParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| q | string | Facultatif | - | L'adresse à rechercher (par ex. : « rue Nizami, Bakou »). |
| reverse | boolean | Facultatif | false | Doit être true pour effectuer un géocodage inverse (recherche de coordonnée vers adresse). |
| point | string | Facultatif | lat,lng | Coordonnée (lat,lng) pour le géocodage inverse en adresse. Requis lorsque reverse=true. |
| limit | integer | Facultatif | 5 | Nombre maximum de résultats à renvoyer (1–20, par défaut 5). |
| lang | string | Facultatif | en | Langue préférée pour les noms de résultats (ex. en, az, ru). Par défaut en. |
| lat | number | Facultatif | - | Latitude pour orienter les résultats (les plus proches d’abord). Avec lon. |
| lon | number | Facultatif | - | Longitude pour orienter les résultats. Avec lat. |
| bbox | string | Facultatif | - | Limiter les résultats à une zone : minLon,minLat,maxLon,maxLat. |
| osm_tag | string | Facultatif | - | Filtrer par tag OSM, ex. place (localités) ou amenity:cafe. Préfixe ! pour exclure. |
| country | string | Facultatif | - | Code pays ISO 3166-1 alpha-2, par exemple AZ. Résultats uniquement dans ce pays. |
| city | string | Facultatif | - | Filtre strict de ville, par exemple Baku. Nécessite exactement un code country. |
| elastic | boolean | Facultatif | true | Recherche élastique (floue, haute couverture) — true par défaut. Tolère fautes de frappe, diacritiques manquants (ə↔e), ordre des mots, mots génériques (metro, rayonu) et numéros de maison. false pour correspondance stricte. |
Filtres de pays et de ville
Sans country, la recherche est mondiale. country=AZ limite les résultats à l’Azerbaïdjan ; country=AZ&city=Bakı à Bakou en Azerbaïdjan. Sans correspondance, HTTP 200 renvoie une liste vide, sans élargir la zone. Une ville sans pays ou un code pays invalide renvoie HTTP 400 InvalidGeocodeFilter. lat/lon influencent uniquement le classement par proximité. Les données sans ville confirmée sont exclues du filtre de ville.
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ı." }Exemples
# Orienter vers un lieu, uniquement localités
GET /api/1/geocode?q=qala&lat=40.41&lon=49.87&osm_tag=place
# Uniquement le pays et la ville sélectionnés
GET /api/1/geocode?q=market&country=AZ&city=Bak%C4%B1
# Géocodage inverse (coordonnées vers adresse)
GET /api/1/geocode?reverse=true&point=40.409,49.867Pour une recherche exacte, indiquer la rue et le numéro dans q. locality et postcode exigent un seul pays. unit sélectionne une unité exacte dans la source et active address_mode=units. Le mode buildings par défaut regroupe les unités situées au même point.
/api/1/geocode?q=101+Main+Street&country=US&locality=Boston&postcode=02129&unit=2&address_mode=unitsExemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/geocode?q=Nizami&country=AZ&city=Bak%C4%B1&lang=az" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- limit: 1–20
- reverse: max_distance_m = 1000
- city: exactly 1 country
Sans résultat, une réponse réussie peut contenir une liste vide. Les filtres de pays/ville ne sont pas élargis. Le détail des adresses dépend de l’index.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"hits": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
],
"took": 12
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "The \"q\" parameter (search text) is required."
}Corrigez les paramètres absents ou invalides.
{
"code": "InvalidGeocodeFilter",
"error": "city requires exactly one country, for example country=AZ&city=Bakı."
}Aucune adresse ni aucun lieu indexé dans le rayon de recherche inverse.
{
"code": "NoNearbyAddress",
"error": "No indexed address or place within 1 km."
}Explication de la structure de la réponse
hits[] : name, city, country, countrycode — lieu et pays, point (lat,lng) — coordonnées ; took — durée (ms). reverse=true : source — source, accuracy — précision, distance_m — distance.
Lieux (POI à proximité)
#Trouvez des points d’intérêt près d’un lieu — cafés, magasins, hôtels, distributeurs, pharmacies, etc. — filtrés par catégorie et rayon, triés par distance.
/api/1/placesParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Coordonnée centrale lat,lng (requis). |
| radius | number | Facultatif | 1 | Rayon de recherche en kilomètres (0.05–20, par défaut 1). |
| category | string | Facultatif | - | Filtre par tag OSM, ex. amenity:cafe, shop, tourism:hotel. Préfixe ! pour exclure. Vide = tous les POI. |
| limit | integer | Facultatif | 10 | Nombre max de résultats (1–50, par défaut 10). |
| lang | string | Facultatif | en | Langue préférée pour les noms (ex. en, az, ru). |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/places?point=40.371,49.845&radius=1&category=amenity:cafe" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- radius: 0.05–20 km
- limit: 1–50
Sans résultat, une réponse réussie peut contenir une liste vide. Les filtres de pays/ville ne sont pas élargis. Le détail des adresses dépend de l’index.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"places": [
{
"name": "Example cafe",
"category": "amenity",
"type": "cafe",
"distance_m": 85,
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
],
"took": 12
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "The \"point\" parameter (lat,lng) is required."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"error": "Places service unavailable."
}Explication de la structure de la réponse
places[] : name, category, type — informations du lieu, distance_m — distance, point (lat,lng) — coordonnées ; took — durée (ms).
Autocomplete API
#Suggestions de lieux rapides et tolérantes aux fautes pendant la saisie, avec pondération géographique.
/api/1/autocompleteParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| q | string | Obligatoire | - | Texte de recherche — saisie partielle acceptée. |
| limit | integer | Facultatif | 8 | Nombre maximum de suggestions (1–15). |
| lang | string | Facultatif | en | Code de langue des libellés. |
| lat | number | Facultatif | - | Latitude pour pondérer les résultats (optionnel). |
| lon | number | Facultatif | - | Longitude pour pondérer les résultats (optionnel). |
| country | string | Facultatif | - | Code pays ISO 3166-1 alpha-2, par exemple AZ. Résultats uniquement dans ce pays. |
| city | string | Facultatif | - | Filtre strict de ville, par exemple Baku. Nécessite exactement un code country. |
| osm_tag | string | Facultatif | - | Filtrer les suggestions par type OSM, ex. place:city. |
Filtres de pays et de ville
Sans country, la recherche est mondiale. country=AZ limite les résultats à l’Azerbaïdjan ; country=AZ&city=Bakı à Bakou en Azerbaïdjan. Sans correspondance, HTTP 200 renvoie une liste vide, sans élargir la zone. Une ville sans pays ou un code pays invalide renvoie HTTP 400 InvalidGeocodeFilter. lat/lon influencent uniquement le classement par proximité. Les données sans ville confirmée sont exclues du filtre de ville.
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ı." }Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/autocomplete?q=niz&lang=az&lat=40.40&lon=49.86" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- limit: 1–15
- city: exactly 1 country
Sans résultat, une réponse réussie peut contenir une liste vide. Les filtres de pays/ville ne sont pas élargis. Le détail des adresses dépend de l’index.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"suggestions": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"label": "Nizami Street, Baku, Azerbaijan"
}
],
"took": 12
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "The \"q\" parameter (search text) is required."
}Corrigez les paramètres absents ou invalides.
{
"code": "InvalidGeocodeFilter",
"error": "city requires exactly one country, for example country=AZ&city=Bakı."
}Explication de la structure de la réponse
Renvoie { suggestions[], took }. Chaque suggestion a label, name, city, state, country, countrycode, type, osm_id et point {lat,lng}.
Batch Geocoding API
#Géocodez jusqu’à 100 adresses par requête. Les résultats suivent l’ordre de saisie et chaque adresse coûte un crédit.
/api/1/geocode/batchParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| queries | array | Obligatoire | [] | Tableau d’adresses à géocoder (max 100). |
| lang | string | Facultatif | en | Code de langue des libellés. |
| limit | integer | Facultatif | 1 | Correspondances maximum par requête (1–5). |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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"}'Limites et coordonnées
Coût en crédits: 1 credit / query
Consultez les champs JSON ; cette requête ne nécessite pas de paire de coordonnées.
- queries: 1–100
- limit: 1–5 / query
- credits = queries.length
Sans résultat, une réponse réussie peut contenir une liste vide. Les filtres de pays/ville ne sont pas élargis. Le détail des adresses dépend de l’index.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"results": [
{
"query": "Baku",
"hits": [
{
"name": "Nizami Street",
"city": "Baku",
"country": "Azerbaijan",
"countrycode": "AZ",
"point": {
"lat": 40.3777,
"lng": 49.8516
}
}
]
}
],
"count": 1,
"took": 12
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Body must include a non-empty \"queries\" array of address strings."
}Corrigez les paramètres absents ou invalides.
{
"error": "A maximum of 100 queries can be geocoded per batch request."
}Explication de la structure de la réponse
Renvoie { results[], count, took }. Chaque résultat associe la requête d’entrée à un tableau hits[] ; chaque correspondance inclut label, city, country et point {lat,lng}. L’ordre d’entrée est conservé.
Timezone API
#Fuseau horaire IANA, décalage UTC actuel, statut de l’heure d’été et heure locale pour toute coordonnée.
/api/1/timezoneParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Facultatif | - | Fournir point=lat,lng ou les deux paramètres lat et lon. |
| lat | number | Facultatif | - | Latitude (alternative à point). |
| lon | number | Facultatif | - | Longitude (alternative à point). |
| timestamp | string | Facultatif | now | Temps Unix (secondes) ou date ISO pour résoudre le décalage ; par défaut maintenant. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/timezone?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- timestamp: Unix seconds | ISO 8601; default = now
- utc_offset_seconds: seconds
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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"
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Explication de la structure de la réponse
Renvoie { timezone, point, utc_offset, utc_offset_seconds, dst, abbreviation, local_time, utc_time }. utc_offset est une chaîne +HH:MM, dst vaut true en heure d’été, et local_time est un horodatage ISO avec le décalage du fuseau.
Elevation API
#Altitude au-dessus du niveau de la mer, en mètres, pour toute coordonnée — un point ou le profil d’un itinéraire entier.
/api/1/elevationParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Coordonnée au format lat,lng. Répétez pour chaque point (jusqu’à 100 en GET). |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/elevation?point=40.4093,49.8671&point=41.30,48.50" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit / 10 points
point=lat,lng ; points JSON : [lat,lng]. Géométrie 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
L’altitude peut être null si les données manquent. Ne remplacez pas une altitude inconnue par zéro.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"results": [
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"elevation": null
}
],
"unit": "meters"
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide at least one point=lat,lng (repeatable)."
}Corrigez les paramètres absents ou invalides.
{
"error": "A maximum of 100 points can be queried per GET request; use POST for larger batches."
}Explication de la structure de la réponse
Renvoie { results[], unit:"meters" }, où chaque résultat est { point:{lat,lng}, elevation }. elevation est en mètres au-dessus du niveau de la mer (null si inconnu, 0 sur mer). Pour un point unique, un champ elevation de niveau supérieur est aussi inclus. Pour les gros lots, POST { points:[[lat,lng],...] } (jusqu’à 1000).
Boundary Lookup API
#Trouvez dans quel pays, région, ville et quartier se trouve une coordonnée — avec le polygone de la limite sur demande.
/api/1/boundaryParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Coordonnée au format lat,lng. |
| polygon | boolean | Facultatif | false | true pour renvoyer aussi la limite en GeoJSON. |
| lang | string | Facultatif | en | Code de langue des noms. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/boundary?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- polygon: true | false
- HTTP 422: BoundaryCoverageUnavailable
Les limites détaillées existent uniquement dans les jeux régionaux acceptés. Les autres points renvoient BoundaryCoverageUnavailable.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
]
]
]
}
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Les données administratives détaillées manquent ici. Consultez la couverture.
{
"code": "BoundaryCoverageUnavailable",
"error": "Detailed administrative boundary data is not available at this coordinate."
}Explication de la structure de la réponse
Renvoie { point, display_name, country, countrycode, state, county, city, district, postcode, osm_id, osm_type } et, avec polygon=true, une géométrie de limite GeoJSON.
Geofencing API
#Vérifiez en un appel dans lesquelles de vos zones tombe chaque point — clôtures polygonales ou circulaires.
/api/1/geofenceParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| fences | array | Obligatoire | [] | Tableau de clôtures : { id?, polygon:[[lat,lng],...] } ou { id?, center:[lat,lng], radius_m }. Jusqu’à 100. |
| points | array | Obligatoire | [] | Tableau de points [lat,lng] à tester (jusqu’à 1000). |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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]]}'Limites et coordonnées
Coût en crédits: 1 credit / 100 points
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- fences: 1–100
- points: 1–1000
- credits = max(1, ceil(points / 100))
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"results": [
{
"point": {
"lat": 40.3777,
"lng": 49.8516
},
"inside": [
"depot"
]
}
],
"count": 1,
"took": 1
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Body must include non-empty \"fences\" and \"points\" arrays."
}Corrigez les paramètres absents ou invalides.
{
"error": "Limits: up to 100 fences and 1000 points per request."
}Explication de la structure de la réponse
Renvoie { results[], count }. Chaque résultat est { point:{lat,lng}, inside:[fenceId,...] } listant toutes les clôtures contenant le point (vide si aucune).
Elevation Profile API
#Altitude en chaque point d’un trajet plus dénivelé positif, négatif et distance — un profil complet.
/api/1/elevation/profileParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| points | array | Facultatif | [] | Tableau de points [lat,lng] du trajet (>=2, jusqu’à 2000). |
| polyline | string | Facultatif | - | Polyline encodée en alternative à points. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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]]}'Limites et coordonnées
Coût en crédits: 1 credit / 10 points
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- points: 2–2000
- credits = max(1, ceil(points / 10))
- elevation: number | null
L’altitude peut être null si les données manquent. Ne remplacez pas une altitude inconnue par zéro.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide a \"points\" array (>=2 [lat,lng]) or an encoded \"polyline\"."
}Corrigez les paramètres absents ou invalides.
{
"error": "A maximum of 2000 points is allowed per request."
}Explication de la structure de la réponse
Renvoie { profile[], total_ascent, total_descent, min_elevation, max_elevation, distance, unit }. Chaque élément { point, elevation, distance } (mètres).
Solar API
#Lever, coucher, crépuscule, midi solaire et durée du jour pour toute coordonnée et date.
/api/1/solarParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | lat,lng | Coordonnée au format lat,lng. |
| date | string | Facultatif | today | Date (YYYY-MM-DD) à calculer ; par défaut aujourd’hui. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/solar?point=40.4093,49.8671&date=2026-07-07" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- date: YYYY-MM-DD; default = today
- times: UTC ISO 8601 | null
Les heures solaires peuvent être null pendant le jour ou la nuit polaire. Les heures sont en UTC.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}Explication de la structure de la réponse
Renvoie { point, date, sunrise, sunset, solar_noon, dawn, dusk, golden_hour, night_start, night_end, day_length_seconds }. Heures en UTC ISO ; null en jour/nuit polaire.
Geometry Utilities API
#Distance, cap, aire, centroïde, simplification et polyline encode/decode — la géométrie en service.
/api/1/geometryParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| op | string | Obligatoire | distance | Opération : distance, bearing, destination, midpoint, length, area, centroid, simplify, polyline_encode ou polyline_decode. |
| from | array | Facultatif | [lat,lng] | Point de départ [lat,lng]. |
| to | array | Facultatif | [lat,lng] | Point d’arrivée [lat,lng]. |
| path | array | Facultatif | [] | Tableau de [lat,lng] (length/simplify/polyline_encode). |
| polygon | array | Facultatif | [] | Anneau [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)Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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]}'Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- op: distance | bearing | destination | midpoint | length | area | centroid | simplify | polyline_encode | polyline_decode
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"op": "distance",
"distance": 2590.25,
"unit": "meters"
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Invalid geometry input for the requested op."
}Explication de la structure de la réponse
Renvoie { op, ... } avec le résultat de l’opération, ex. { distance, unit }, { bearing_deg }, { point }, { area, unit }, { path } ou { polyline }.
Coordinate Conversion API
#Convertit latitude/longitude vers et depuis les références de grille UTM et MGRS.
/api/1/convertParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Facultatif | lat,lng | Coordonnée lat,lng à convertir en UTM/MGRS. |
| mgrs | string | Facultatif | - | Chaîne MGRS à reconvertir en coordonnée. |
Fournir point=lat,lng, les deux paramètres lat et lon, ou mgrs. Un mgrs non vide est prioritaire. La conversion inverse renvoie le centre de la cellule MGRS et omet utm.
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/convert?point=40.3755,49.8516" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
point=lat,lng ; points JSON : [lat,lng]. Géométrie GeoJSON : [lon,lat].
- point=lat,lng OR (lat=... AND lon=...) OR mgrs=...
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"point": {
"lat": 40.3755,
"lng": 49.8516
},
"mgrs": "39TVE0251070068",
"utm": {
"zone": 39,
"band": "T",
"easting": 402511,
"northing": 4470068,
"hemisphere": "N"
}
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide point=lat,lng (or lat= & lon=), or mgrs= to reverse-convert."
}Explication de la structure de la réponse
Renvoie { point, mgrs, utm:{ zone, band, easting, northing, hemisphere } }. Avec mgrs=, renvoie { mgrs, point }.
Country Info API
#Devise, indicatif, langues, capitale et drapeau de tout pays par code ISO ou nom.
/api/1/countryParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| code | string | Facultatif | AZ | Code pays ISO 3166 alpha-2 ou alpha-3 (ex. AZ ou AZE). |
| name | string | Facultatif | - | Nom du pays en alternative au code. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/country?code=AZ" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 1 credit
Consultez les champs JSON ; cette requête ne nécessite pas de paire de coordonnées.
- code=ISO2/ISO3 OR name=...
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide code=ISO2/ISO3 or name=CountryName."
}Utilisez un code valide ou le nom exact du pays.
{
"error": "Country not found."
}Explication de la structure de la réponse
Renvoie { name, official_name, cca2, cca3, capital, region, subregion, currency:{code,name,symbol}, calling_code, languages[], flag, latlng }.
Isochrone API
#Estime l’accessibilité à partir des temps de trajet vers des points échantillonnés. Si chaque direction contient un point accessible, quality.status vaut estimated ; sinon il vaut insufficient_data et polygons est vide. Un résultat vide ne prouve pas l’absence de routes accessibles. La limite est approximative ; seules les limites de temps sont prises en charge.
/api/1/isochroneParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| point | string | Obligatoire | - | Point central. Format : lat,lon. |
| time_limit | integer | Facultatif | 600 | Limite de temps de trajet (en secondes). |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
curl "https://osrmroute.com/api/1/isochrone?point=40.4093,49.8671&time_limit=600" -H "Authorization: Bearer YOUR_KEY"Limites et coordonnées
Coût en crédits: 2 credits / minute; minimum 10
point=lat,lng ; points JSON : [lat,lng]. Géométrie 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))
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
]
]
]
}
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "point parameter is required"
}Vérifiez les limites de complexité et les restrictions de la clé.
{
"error": "The Isochrone API is not available on your plan. Upgrade your plan to use it."
}Choisissez un profil pris en charge. Aucun basculement automatique vers la voiture.
{
"code": "ProfileNotAvailable",
"error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}Le service ou sa source sont indisponibles. Réessayez prudemment avec des pauses croissantes.
{
"code": "RoutingTimeout",
"error": "The routing service did not respond within the request deadline. Retry later."
}Explication de la structure de la réponse
polygons[] — GeoJSON Feature ; geometry — Polygon [lon,lat] ; properties.time_limit — limite de temps (s).
Route Optimization API
#Planifie les tournées avec des contraintes de capacité, créneaux horaires, compétences et enlèvements/livraisons liés. Une heuristique à durée limitée réduit le trajet sans garantir un optimum global. Les tâches non affectées restent dans solution.unassigned ; les entrées invalides sont rejetées intégralement.
/api/1/vrpParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| vehicles | array | Facultatif | one default vehicle | La liste des véhicules — chacun avec un id, une capacité optionnelle et un point de départ sous forme de tableau [lon, lat] (longitude d'abord). |
| services | array | Facultatif | [] | Les arrêts à desservir — chacun avec un id, une position sous forme de tableau [lon, lat] (longitude d'abord) et un temps de service optionnel. |
| shipments | array | Facultatif | [] | Tâches liées d’enlèvement et de livraison avec amount et skills. Fournir services, shipments ou les deux ; au maximum 250 points de tâche. |
| profile | string | Facultatif | driving | Profil commun : driving, cycling ou walking, avec les noms alternatifs documentés. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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]}]}'Limites et coordonnées
Coût en crédits: max(10, ceil(vehicles * task_points * 13 / 15)) credits
Tableaux VRP start/location : [lon,lat] ; objets : lat et lng/lon. Temps en secondes.
- 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
Les profils voiture, marche et vélo sont mondiaux. Les points doivent être reliés par des voies autorisées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"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
}
]
}
]
}
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"code": "InvalidOptimizationInput",
"error": "At least one service with valid coordinates is required."
}Vérifiez les limites de complexité et les restrictions de la clé.
{
"error": "Your plan allows up to 1 vehicles per request. Upgrade your plan for more."
}Vérifiez que les points sont proches de routes accessibles et que ces routes sont reliées pour le profil choisi.
{
"code": "NoNearbyRoad",
"error": "No connected route within 2000 metres of the requested coordinates."
}Explication de la structure de la réponse
status → finished ; job_id — identifiant ; solution : distance — distance (m), time et costs — temps (s), no_vehicles, no_unassigned — nombres, routes[] — trajets. routes[] : vehicle_id, distance (m), transport_time (s), activities[] — activités.
Location Clustering API
#Regroupe (en clusters) les coordonnées données selon leur proximité et leur densité géographique.
/api/1/clusterParamètres (Query Params)
| Paramètre | Type | Statut | Par défaut | Description |
|---|---|---|---|---|
| customers | array | Obligatoire | [] | Coordonnées des clients et poids à regrouper en clusters. |
Exemple de requête
Remplacez YOUR_KEY par votre clé API. Les requêtes consomment des crédits ; copier cet exemple n’envoie aucune requête.
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}'Limites et coordonnées
Coût en crédits: 3 credits
Coordonnées client en entrée : [lon,lat] ; centre en sortie : [lat,lon].
- customers: valid coordinates ≥ 1
- 1 ≤ clusters ≤ valid_customers.length
Validez le format d’entrée et les unités indiquées.
Offres et tarifs actuelsCouverture par serviceExemple de réponse JSON
Exemple JSON illustratif et abrégé. Les valeurs, champs facultatifs et données cartographiques peuvent varier. Les distances sont en mètres et les durées en secondes, sauf indication contraire.
{
"status": "finished",
"job_id": "cluster-1234567890",
"processing_time": 0,
"no_clusters": 1,
"clusters": [
{
"ids": [
"s1",
"s2"
],
"center": [
40.385,
49.855
],
"size": 2
}
]
}Erreurs du service
Corrigez les paramètres absents ou invalides.
{
"error": "Provide a \"customers\" array with valid coordinates."
}Explication de la structure de la réponse
status → finished ; job_id — identifiant ; no_clusters — nombre de groupes ; clusters[] : ids[] — éléments, center [lat,lon] — centre, size — taille.
Endpoints de compatibilité
Avant de migrer une intégration, vérifiez l’ordre des coordonnées et les unités de réponse.
L’URL Routing raccourcie accepte les mêmes données que la route OSRM. L’ancienne Route reçoit des paires latitude,longitude répétées. paths[].time est en millisecondes et paths[].distance en mètres. Route info décrit la couverture configurée et coûte un crédit.
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/infoL’ancienne Matrix accepte des paramètres point répétés ou des listes from_point et to_point. En JSON, envoyez from_points et to_points comme paires latitude,longitude. Les temps sont en millisecondes et les distances en mètres.
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]]}L’ancienne Match accepte une trace GPS ordonnée en paires [lon, lat]. En option, fournissez une date en secondes et un rayon en mètres par point. Les distances sont en mètres et les temps en millisecondes. Elevation ([lat, lon]) par lot accepte 1 000 paires au maximum et renvoie des mètres ou 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 et vrp/optimize utilisent le format VRP. Les alias de regroupement et de géocodage par lot reprennent les formats principaux. VRP et le regroupement renvoient directement leurs résultats.
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 officiels
Kotlin pour Android/JVM et Swift pour iOS. Des modèles typés et des requêtes asynchrones pour les API géographiques OSRMRoute.