Matrix Service

get

https://us1.locationiq.com/v1/matrix/{profile}/{coordinates}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile

string

enum

required

Mode of transportation. driving and walking are supported.

Allowed:

coordinates

string

required

String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}).
You can send up to a maximum of 25 coordinate pairs per request (except Nearest API where coordinates only supports a single {longitude},{latitude} entry)

Query Params

bearings

string

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

radiuses

string

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)

hints

string

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

sources

integer

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

destinations

integer

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

annotations

string

Defaults to false

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

fallback_speed

number

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_coordinate

string

Defaults to input

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.

Responses

200OK

400Bad Request

401Unauthorized

403The request has been made from an unauthorized domain.

404No location or places were found for the given input

429Request exceeded the rate-limits set on your account

500Internal Server Error