API Reference

Matrix API Reference

Base URL

https://routing.maptoolkit.net

Endpoints

`GET /matrix`

Calculate a travel time and distance matrix

Returns a 2D matrix of travel times and distances for all combinations of from and to coordinates. Times are in seconds, distances are in meters. Distances are not available for routeType=transit. If a route cannot be found, the value is null.

Parameter	In	Type	Required	Description
`from`	query	array	Yes	Origin coordinate in `lat,lng` format. Repeat to specify multiple origins.
`routeType`	query	string	Yes	Travel mode. Accepted values are `car`, `bike`, `foot`, and `transit`. One of: `car`, `bike`, `foot`, `transit`.
`to`	query	array	Yes	Destination coordinate in `lat,lng` format. Repeat to specify multiple destinations.
`callback`	query	string	No	Wraps the response in a JSONP callback function with this name.
`departure`	query	string	No	Departure time for transit routing as an ISO 8601 date-time string. Default: current time.
`vehicle`	query	string	No	Deprecated. Use `routeType` instead. One of: `car`, `bike`, `foot`, `transit`.

Status Description

200 Travel time and distance matrix.

Status	Description
`200`	Travel time and distance matrix.
`400`	Bad request. Transit errors `Cannot parse departure time!` — `departure` value is not a valid date string. Profile errors `Only car,bike,foot,transit profile is allowed` — `routeType` must be one of the listed values. General errors Upstream routing engine error message forwarded as-is.
`500`	Internal server error.

400

Bad request.

Transit errors

Cannot parse departure time! — departure value is not a valid date string.

Profile errors

Only car,bike,foot,transit profile is allowed — routeType must be one of the listed values.

General errors

Upstream routing engine error message forwarded as-is.

500 Internal server error.

`POST /matrix`

Calculate a travel time and distance matrix (POST)

Same as GET but accepts parameters in the request body. Useful when querying many origins or destinations.