Options
Use ISO-3 codes, comma separated, e.g., AUT,ITA,HRV
Batch Routing!
1-to-many = from one origin (e.g., Source location) to many destinations (e.g., Gas Stations)
many-to-many = from many origins (e.g., Multiple Sources) to many destinations (e.g., Gas Stations)
many-to-1 = from many origins (e.g., Multiple Sources) to one destination (e.g. Gas Station)
Options: (This options is currently only considered for travelMode truck)
Valhalla Options
Trucks
Sources
Destinations
Options:
Routing Mode
Type segment of mode param.
TransportModes segment of mode param.
TrafficMode segment of mode param.
RouteFeature segment of mode. 0=normal, -3=strict avoid. Ctrl/Cmd for multi-select.
xs:dateTime. Use now for current time. E.g. 2021-07-04T17:00:00+02:00
Measure to optimize. Default: time.
Not supported for pedestrian, bicycle, scooter.
Comma-separated HERE link IDs the route must not cross.
Up to 20 bounding boxes. Format: lat1,lng1;lat2,lng2. Separate boxes with !.
Vehicle Specifications
Truck routing only.
Total weight incl. payload & trailers. Units: t, kg, lbs. E.g. 7.5t, 7500kg.
For WPS: kg only, no unit suffix. E.g. 4000. Accepts t, kg, lbs otherwise.
Incl. trailers. Units: cm, m, in. E.g. 13.6m, 1360cm.
Incl. trailers. Units: cm, m, in. E.g. 2.24m.
Incl. trailers. Units: cm, m, in. E.g. 2.4m.
Value 4 (semi-trailers) is NOT supported for WPS.
Only applies when transport mode is pedestrian.
Hazardous Goods & Tunnel Restrictions
Tunnel categories the truck must NOT use.
Note: allhazardousGoods and explosiveFlammable are NOT supported for WPS. Ctrl/Cmd for multi-select.
Timing, Rest & Break Times
Format: durations:{shortDrive},{shortRest},{longDrive},{longRest};serviceTimes:work|rest
Max 5 break slots. Format: xs:dateTime;durationInSeconds, comma-separated.
Format: timeInSeconds,distanceInMeters. E.g. 7200,250000.
Cost Parameters
Arbitrary currency unit per hour.
Arbitrary currency unit per kilometer.
Routing API v8 Options:
Transport & Routing Mode
Required. Note: bicycle, bus, privateBus, taxi are beta with limited functionality.
Note: bicycle, bus, pedestrian, privateBus, scooter, taxi only support fast.
Max 6 alternative routes in addition to the optimal route.
Units used in guidance instructions.
IETF BCP 47. Comma-separated list. First supported language is used. Default: en-US.
ISO 4217 currency code. Used for toll cost reporting.
Timing
RFC 3339 date-time. Leave blank for current time. Use any to ignore time. Cannot be combined with arrivalTime.
RFC 3339. Not supported with EV routing, Route Handle, or Route Import. Cannot be combined with departureTime.
Avoidances
Ctrl/Cmd to multi-select. Use avoid[features]=... in request.
Format: bbox:west,south,east,north. Separate multiple with |. Max 20.
Comma-separated HERE segment IDs. Append #+ or #- for direction, #* for both.
Avoid all zones in the selected category. Combine with avoid[zoneIdentifiers] for exceptions.
Comma-separated HERE zone IDs.
Truck-specific road type avoidances. Ctrl/Cmd to multi-select.
Exclude (Strict)
Format: COUNTRY:STATE. Multiple countries separated by |.
Format: bbox:west,south,east,north. Separate multiple with |.
Vehicle Parameters
Total weight incl. payload and trailers.
Format: single:{kg};tandem:{kg};triple:{kg}
Vehicle height including load, in centimeters.
Vehicle length including trailers, in centimeters.
ADR tunnel category the vehicle must NOT use.
Ctrl/Cmd to multi-select.
Current actual weight. Required when using currentWeightChange on via waypoints.
Number of occupants. Affects HOV lane eligibility and toll calculation.
Affects environmental zone restrictions and toll cost.
Affects environmental zone access.
Traffic
If departureTime=any + default, only long-term incidents are used.
Tolls
Comma-separated transponder IDs. Enables transponder-discounted toll costs.
Driver (Rest Stops)
Max continuous work hours before mandatory rest. Triggers auto rest stop insertion.
Duration of mandatory rest, in hours.
Pedestrian
Influences walking segment duration. Only applies when transportMode=pedestrian.
Scooter
avoid[features]=controlledAccessHighway takes precedence over this setting.
Taxi
Allow driving through taxi-only roads and lanes.
Return (Response Content)
Ctrl/Cmd to multi-select. Defines attributes included in the response.
Requires polyline in Return. Ctrl/Cmd to multi-select.
Matrix Routing API v8 Options: POST /v8/matrix?async=false
Calculation Mode
Mode: Flexible — regionDefinition=world, no profile. Supports custom options & live traffic. Matrix limit: 15×100 or 100×1 (sync).
Determines calculation mode. world = Flexible or Profile. Others = Region mode (max 400 km diameter, 500×500 sync).
Transport & Routing
Ignored in Profile mode (profile param takes precedence).
RFC 3339 date-time. Enables live traffic in Flexible & Region modes. Not used in Profile mode.
What to include in the result matrix. Default: travelTimes only. Ctrl/Cmd to multi-select.
Avoidances
Ctrl/Cmd to multi-select. Not supported in Profile mode.
Format: bbox:west,south,east,north. Separate multiple with |. Not supported in Profile mode.
Truck Parameters transportMode=truck only
EV & Consumption Required for consumptions matrixAttribute
Required for empirical model. Pairs of speed (km/h) and consumption (kWh/m).