Generate Matrix request format

POST https://distancematrix.api.mappable.world/v2/async//{mode}/matrices/generate
  ? apikey=<string>
  & [departure_time=<integer>]
  & [avoid_tolls=<boolean>]
  & [avoid_zones=<lon1,lat1|lon2,lat2|...>&avoid_zones=<lon1,lat1|lon2,lat2|...>]
  & [traffic=<string>]
  & [weight=<float>]
  & [axle_weight=<float>]
  & [max_weight=<float>]
  & [height=<float>]
  & [width=<float>]
  & [length=<float>]
  & [payload=<float>]
  & [eco_class=<integer>]
  & [has_trailer=<boolean>]
Content-Type: application/json

{
  "origins": [
    [lat1, lon1],
    [lat2, lon2],
    ...
  ],
  "destinations": [
    [lat1, lon1],
    [lat2, lon2],
    ...
  ]
}

All params

mode

Required parameter
Provided in the request path

Type of travel on the route. Acceptable values:

  • driving: Passenger car route.
  • truck: Truck route.

apikey

Required parameter

The key issued in the Mappable Account.

Note

The async matrix generation is currently available only upon request.

If you need it, send us an email at sales@mappable.world.

origins

Required parameter
Provided in the request body

The origin points for routes specified in decimal degrees.
Each point is defined as a coordinate pair in the format: [latitude, longitude]

destinations

Required parameter
Provided in the request body

The destination points of routes specified in decimal degrees.
Each point is defined as a coordinate pair in the format: [latitude, longitude]

Routes are created from each origin point to all of the destinations. The maximum size of the resulting matrix is 25 million cells.

departure_time

The departure time in UNIX time. Used for calculating the expected traffic congestion. If this parameter is omitted, the traffic forecast is made for the time of request processing.
This value can't be in the past.

Warning

This parameter is not used when calculating routes without traffic jams (traffic=disabled).

avoid_tolls

No toll roads. When true, the route avoids toll roads. Default value: false.

avoid_zones

Set up a custom polygon on the map to avoid it during routing. You can set up multiple polygons in the request. Each polygon should has at least 3 points.

traffic

Change the type of road traffic. When disabled, the route is built according to the shortest distance, without traffic jams.

weight

Vehicle weight in tons (only for mode=truck).

axle_weight

Actual vehicle axle load in tons (only for mode=truck).

max_weight

Maximum allowed vehicle weight in tons (only for mode=truck).

height

Vehicle height in meters (only for mode=truck).

width

Vehicle width in meters (only for mode=truck).

length

Vehicle length in meters (only for mode=truck).

payload

Maximum vehicle load capacity in tons (only for mode=truck).

eco_class

Vehicle emission standard (only for mode=truck).

has_trailer

Trailer (only for mode=truck). Default value: false.
Previous
Quick start
Next
Generate Matrix response