v1

latestOpenAPI 3.0.02026-07-241437122.4 KB
Routing

Matrix Service

Computes duration of the fastest route between all pairs of supplied coordinates. Returns the durations or distances or both between the coordinate pairs. Note that the distances are not the shortest distance between two coordinates, but rather the distances of the fastest routes.

get/matrix/{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} ...]

sourcesinteger

Use location with given index as source. Accepted value: {index};{index}[;{index} ...] or all (default). Each {index} has the following format: 0 <= integer < #locations

destinationsinteger

Use location with given index as destination. Accepted value: {index};{index}[;{index} ...] or all (default) Each {index} has the following format: 0 <= integer < #locations

annotationsstring

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

fallback_speednumber

If no route found between a source/destination pair, calculate the as-the-crow-flies distance, then use this speed to estimate duration. Accepted value: double > 0

fallback_coordinatestring

When using a fallback_speed, use the user-supplied coordinate (input), or the snapped location (snapped) for calculating distances. Accepted value: input (default), or snapped.

Response

OK

codestring

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

fallback_speed_cellsnumber[]