Request format

https://router.api.mappable.world/v2/
  ? apikey=<string>
  & waypoints=<lon1,lat1|lon2,lat2|...>
  & [mode=<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>]
  & [levels=<string>]

All params

apikey

Required parameter

The key issued in the Mappable Account.

Note

Key activation takes up to 15 minutes.

waypoints

Required parameter

Route points specified in decimal degrees (WGS84 standard).
Each point is defined as a coordinate pair in the format: <longitude,latitude>
Coordinate pairs (points) are separated with a vertical bar «|».

  • If driving or truck is specified in the mode field, the maximum number of elements is 50.
  • For other types of travel, the maximum number of elements is 25.

mode

Type of travel on the route. Acceptable values:

  • driving: Passenger car route. Used by default.
  • truck: Truck route.
  • walking: Walking route.
  • transit: Public transit route.
  • bicycle: Bicycle route.
  • scooter: Electric scooter route.

departure_time

The departure time in UNIX time. Used for calculating the expected traffic congestion. If this parameter is not specified, the traffic forecast is made for time when the request was processed.
This value can't be in the past.

Alert

This parameter is not used when calculating routes:

  • for walking, bicycle or electric scooter (mode=walking, mode=bicycle or mode=scooter),
  • without traffic jams (traffic=disabled).

avoid_tolls

Only for mode=driving or mode=truck

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

avoid_zones

Only for mode=driving or mode=truck

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

Only for mode=driving or mode=truck

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

weight

Only for mode=truck

Vehicle weight in tons.

axle_weight

Only for mode=truck

Actual vehicle axle load in tons.

max_weight

Only for mode=truck

Maximum allowed vehicle weight in tons.

height

Only for mode=truck

Vehicle height in meters.

width

Only for mode=truck

Vehicle width in meters.

length

Only for mode=truck

Vehicle length in meters.

payload

Only for mode=truck

Maximum vehicle load capacity in tons.

eco_class

Only for mode=truck

Vehicle emission standard.

has_trailer

Only for mode=truck

Trailer. Default value: false.

levels

Only for mode=walking or mode=transit

Floor levels for route points, specified as a comma-separated list. The number of levels must match the number of points in the waypoints parameter.

Access to this parameter is provided on paid plans.
Previous
Quick start
Next
Response