Matrix API | API Docs (original) (raw)

The Mapbox Matrix API returns travel times between many points.

For example, given three locations A, B, and C, the Matrix API will return a matrix of all travel times in seconds between the locations:

A B C
A A → A A → B A → C
B B → A B → B B → C
C C → A C → B C → C

The Matrix API will always return the duration or the distance on the fastest route for each element in the matrix, where an element is an origin-destination pair in the matrix. The Matrix API returns durations in seconds and distances in meters. It does not return route geometries.

Durations or distances between points may not be symmetric, since the routes may differ by direction due to one-way streets or turn restrictions. For example, A to B may have a different duration than B to A.

The Matrix API allows you to efficiently check the reachability of coordinates from each other, filter points by travel time, or run your own algorithms for solving optimization problems.

Retrieve a matrix​

get

https://api.mapbox.com

/directions-matrix/v1/{profile}/{coordinates}

Returns a duration matrix, a distance matrix, or both, showing travel times and distances between coordinates.

In the default case, this endpoint returns a symmetric matrix that uses all the input coordinates as sources and destinations (N×N). Using the optional sources and destination parameters, you can also generate an asymmetric matrix that uses only some coordinates as sources or destinations: one to many (1×N), many to one (N×1), and several to several (M×N). To learn more about how to use these parameters to create each of these matrix types, see the Directions getting started guide.

Required parameters Type Description
profile string A Mapbox Directions routing profile ID. Profile IDDescriptionmapbox/drivingCar travel times, distances, or both.mapbox/walkingPedestrian and hiking travel times, distances, or bothmapbox/cyclingBicycle travel times, distances, or bothmapbox/driving-trafficCar travel times, distances, or both as informed by traffic data
coordinates number A semicolon-separated list of {longitude},{latitude} coordinates. There must be between two and 25 coordinates. For the mapbox/driving-traffic profile, the maximum is 10 coordinates.

You can further refine the results from this endpoint with the following optional parameters:

Optional parameters Type Description
annotations string Used to specify the resulting matrices. Possible values are: duration (default), distance, or both values separated by a comma.
approaches string A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route. Accepts unrestricted (default, route can arrive at the waypoint from either side of the road) or curb (route will arrive at the waypoint on the driving_side of the region). If provided, the number of approaches must be the same as the number of waypoints. But, you can skip a coordinate and show its position in the list with the ; separator.
bearings string A semicolon-separated list of headings and allowed deviation indicating the direction of movement. Used to filter the road segment a waypoint will be placed on by the device’s orientation. This is useful for making sure new routes of rerouted vehicles continue traveling in their desired direction. Input as two comma-separated values per location: a heading course measured clockwise from true north between 0 and 360, and the range of degrees by which the angle can deviate (recommended value is 45° or 90°), formatted as {angle, degrees}. If provided, the number of provided bearings must equal the number of locations; you can skip a coordinate and show its position in the list with the ‘;’ separator.
destinations integer or string Use the coordinates at a given index as destinations. Possible values are: a semicolon-separated list of 0-based indices, or all (default). The option all allows using all coordinates as destinations.
sources integer or string Use the coordinates at a given index as sources. Possible values are: a semicolon-separated list of 0-based indices, or all (default). The option all allows using all coordinates as sources.
fallback_speed LEGACY integer By default, if there is no possible route between two points, the Matrix API sets the resulting matrix element to null. To circumvent this behavior, set the fallback_speed parameter to a value greater than 0 in kilometers per hour. The Matrix API will replace a null value with a straight-line estimate between the source and destination based on the provided speed value.
depart_at BETA string Specifies the desired time of departure to account for future traffic conditions and road restrictions; the matrix will be calculated based on a specified profile to determine conveyance type and desired or required traffic data. Formatted in one of three ISO 8601 formats: YYYY-MM-DDThh:mm:ssZ, YYYY-MM-DDThh:mmss±hh:mm, or YYYY-MM-DDThh:mm. In the last format, the timezone is calculated from the route origin. If left blank, depart_at will be calculated as the present time in the local timezone of the first coordinates. Set the depart_at property to the current time or some time in the future. It cannot be in the past. To use this feature, sign up here.

Unrecognized options in the query string will result in an InvalidInput error.

Example request: Retrieve a matrix​

Response: Retrieve a matrix​

The response to a Matrix API request is a JSON object that contains the following properties:

Property Type Description
code string A string indicating the state of the response. This is a separate code than the HTTP status code. On normal valid responses, the value will be Ok. See the errors section below for more information.
durations array Durations as an array of arrays that represent the matrix in row-major order. durations[i][j] gives the travel time from the ith source to the jth destination. All values are in seconds. The duration between the same coordinate is always 0. Finding no duration, the result will be null.
distances array Distances as an array of arrays that represent the matrix in row-major order. distances[i][j] gives the travel distance from the ith source to the jth destination. All values are in meters. The distance between the same coordinate is always 0. Finding no distance, the result will be null.
sources array An array of waypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoints appear in the array in the order of the input coordinates, or in the order specified in the sources query parameter.
destinations array An array of waypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoints appear in the array in the order of the input coordinates, or in the order specified in the destinations query parameter.

Note: When a route is not found between a source and a destination, the corresponding value in the durations or distances matrix will be null.

Example response: Retrieve a matrix​

Supported libraries: Retrieve a matrix​

Mapbox wrapper libraries help you integrate Mapbox APIs into your existing application. The following SDKs support this endpoint:

See the SDK documentation for details and examples of how to use the relevant methods to query this endpoint.

Matrix API errors​

On error, the server responds with different HTTP status codes:

Response body code HTTP status code Description
Ok 200 Normal success case.
NoRoute 200 There was no route found for the given coordinates. Check for impossible routes (for example, routes over oceans without ferry connections) or incorrectly formatted coordinates.
null 200 Request contains both routable and unroutable coordinate pairs; "null" is returned for unroutable coordinate pairs only.
Not Authorized - No Token 401 No token was used in the query.
Not Authorized - Invalid Token 401 Check the access token you used in the query.
Forbidden 403 There may be an issue with your account. Check your Account page for more details.In some cases, using an access tokens with URL restrictions can also result in a 403 error. For more information, see our Token management guide.
ProfileNotFound 404 Use a valid profile as described in Retrieve a matrix.
InvalidInput 422 The given request was not valid. The message key of the response will hold an explanation of the invalid input.

Matrix API restrictions and limits​

If you require a higher rate limit,contact us.

Matrix API pricing​

The Matrix API handles bulk requests of widely varying sizes, so billing is tracked by the number of elements returned instead of the number of requests made. For instance, one request from the Matrix API can be many different origin and destination pairs, so one request from the Matrix API is equal to the number of sources multiplied by the number of destinations:

By default, the Matrix API returns a symmetric matrix, using all input coordinates as both sources and destinations. In this case, the number of elements is the number of coordinates2. You can also generate an asymmetric matrix, with only some coordinates as sources or destinations. In an asymmetric matrix, the number of elements per request is the number of sources multiplied by the number of destinations. The minimum number of elements to retrieve travel times and distances for is two.

Details about the number of Matrix API requests included in the free tier and the cost per request beyond what is included in the free tier are available on the pricing page. For high volume use of the Mapbox Matrix API, contact our sales team for pricing.

Additional Developer Resources