v1

latestOpenAPI 3.0.02026-07-241437122.4 KB
Routing

Directions Service

Finds the fastest route between coordinates in the supplied order.

get/directions/{profile}/{coordinates}

Query parameters

bearingsstring

Limits the search to segments with given bearing in degrees towards true north in clockwise direction. List of positive integer pairs separated by semi-colon and bearings array should be equal to length of coordinate array. Accepted Value :- {bearing};{bearing}[;{bearing} ...] Each {bearing} follows the following format: {value},{range} integer 0 .. 360,integer 0 .. 180

radiusesstring

Limits the search to given radius in meters Radiuses array length should be same as coordinates array, each value separated by semi-colon. Accepted Value - {radius};{radius}[;{radius} ...] Each {radius} has following format: double >= 0 or unlimited (default)

hintsstring

Hint from previous request to derive position in street network. Accepted value: {hint};{hint}[;{hint} ...]

alternativesnumber

Search for alternative routes. Passing a number alternatives=n searches for up to n alternative routes. Accepted value: true, false (default), or Number

stepsstring

Returned route steps for each route leg. Accepted value: true, false (default)

annotationsstring

Returns additional metadata for each coordinate along the route geometry. Accepted value: true, false (default), nodes, distance, duration, datasources, weight, speed

geometriesstring

Returned route geometry format (influences overview and per step). Accepted value: polyline (default), polyline6, geojson

overviewstring

Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Accepted value: simplified (default), full, false

continue_straightstring

Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Accepted value: default (default), true, false. Default value depends on the profile.

waypointsstring

Treats input coordinates indicated by given indices as waypoints in returned Match object. Default is to treat all input coordinates as waypoints. {index};{index};{index}... ]

Response

OK

codestring

If the request was successful Ok otherwise see the service dependent and general status codes.