Directions
Turn ordered waypoints into routes, compare alternatives, and interpret geometry and maneuver details.
From points to a journey
Directions connects ordered waypoints through the road network using your travel profile. A route contains a summary and legs between consecutive waypoints.
From waypoints to a routeIllustration
1Ordered waypoints2Connected route3One leg per pair
Start with a working example
curl -X POST 'https://api.uat.audisory.com/v1/directions' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"coordinates": [
[
30.0619,
-1.9441
],
[
30.1395,
-1.9686
]
],
"profile": "moto"
}'Read the result
- Route distance is in metres and estimated duration is in seconds.
- Legs correspond to consecutive waypoints; optional maneuver details support step-by-step presentation.
- Geometry is encoded route data. Use its documented encoding rather than treating it as GeoJSON coordinates.
- Alternative routes are candidates, not an assurance that multiple distinct routes always exist.
Choose inputs deliberately
Use longitude, latitude and a profile matching the journey. Terrain and access influence routing. Local road disruptions entered by staff are not yet guaranteed to affect serving artifacts, and estimates do not imply observed live traffic.
Explore the request schema
| Field | Type | Description |
|---|---|---|
coordinatesrequired | array | Waypoints in visiting order, starting with the origin.Nested fields{
"type": "array",
"description": "A WGS84 position as `[longitude, latitude]`, in that order.",
"minItems": 2,
"maxItems": 2,
"prefixItems": [
{
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees.",
"minimum": -180,
"maximum": 180
},
{
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees.",
"minimum": -90,
"maximum": 90
}
],
"x-go-type": "[]float64",
"examples": [
[
30.0619,
-1.9441
]
]
} |
profile | string | The vehicle and behaviour model used for costing. `moto` is the motorcycle-taxi profile and
the one most Rwandan traffic actually uses.
["moto","car","truck","bicycle","pedestrian","pedestrian_loaded"] |
departure_time | string | Departure time. Supplying it applies time-conditioned restrictions such as bus lanes and market-day closures. Defaults to now. |
alternatives | integer | Number of alternative routes to return in addition to the best one. |
geometry_format | string | Encoding of the returned route geometry. ["polyline6","geojson"] |
include_steps | boolean | Include turn-by-turn maneuver steps in each route leg. |
Continue
See the generated directions reference for all supported fields and response schemas, or open the playground to explore a route.