tomtom-waypoint-routing
Plan optimized routes by calculating paths through specified waypoints. Select route types, avoid specific road features, and include real-time traffic data for accurate navigation across multiple travel modes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accelerationEfficiency | No | Efficiency during acceleration (0-1). | |
| alternativeType | No | When maxAlternatives is greater than 0, it allows the definition of computing alternative routes: finding routes that are significantly different from the reference route, or finding routes that are better than the reference route. Possible values are: `anyRoute` (returns alternative routes that are significantly different from the reference route.), `betterRoute` (only returns alternative routes that are better than the reference route, according to the given planning criteria (set by routeType). If there is a road block on the reference route, then any alternative that does not contain any blockages will be considered a better route. The summary in the route response will contain information (see the planningReason parameter) about the reason for the better alternative.) Note: The betterRoute value can only be used when reconstructing a reference route. Default value: `anyRoute` Other values: `betterRoute` | |
| arriveAt | No | Arrival time in ISO format (e.g., '2025-06-24T17:00:00Z'). Cannot be used with departAt. | |
| auxiliaryPowerInLitersPerHour | No | Auxiliary power consumption for combustion vehicles in L/hr. | |
| auxiliaryPowerInkW | No | Auxiliary power consumption in kW for electric vehicles. | |
| avoid | No | Route features to avoid. May increase travel time. Options: 'tollRoads','motorways','ferries','unpavedRoads','carpools','alreadyUsedRoads'. Accepts array of string(s). | |
| chargeMarginsInkWh | No | Comma-separated charge margins in kWh for route planning. | |
| computeBestOrder | No | Reorder waypoints for optimization. Use with multiple waypoints to find the most efficient route order. | |
| computeTravelTimeFor | No | Calculate travel times for all segments ('all') or none ('none'). | |
| constantSpeedConsumptionInLitersPerHundredkm | No | Combustion speed-to-consumption mappings: '50,6.3:130,11.5' (speed in km/h, consumption in L/100km). | |
| constantSpeedConsumptionInkWhPerHundredkm | No | EV speed-to-consumption mappings format: '50,8.2:130,21.3' (speed in km/h, consumption in kWh/100km). | |
| consumptionInkWhPerkmAltitudeGain | No | Energy used per km of altitude gain. | |
| currentChargeInkWh | No | Current EV battery charge in kWh. Required for EV routing. | |
| currentFuelInLiters | No | Current fuel level in liters for combustion vehicles. | |
| decelerationEfficiency | No | Efficiency during deceleration (0-1). | |
| departAt | No | Departure time in ISO format (e.g., '2025-06-24T14:30:00Z'). Cannot be used with arriveAt. | |
| downhillEfficiency | No | Efficiency during downhill driving (0-1). | |
| extendedRouteRepresentation | No | Additional routing data formats to include in the response. | |
| fuelEnergyDensityInMJoulesPerLiter | No | Fuel energy density in megajoules per liter. | |
| hilliness | No | Preference for avoiding hills. Use 'low' for flatter routes. | |
| includeTollPaymentTypes | No | Include toll payment types in the toll section. If a toll section has different toll payment types in its subsections, this toll section is split into multiple toll sections with the toll payment types. Possible values: all(Include toll payment types in the toll section.), none (Do not include toll payment types in the toll section). The value `all` must be used together with sectionType=toll. Default value: none | |
| instructionsType | No | Instruction format: 'text' (human-readable), 'coded' (machine-readable), 'tagged' (HTML). | |
| language | No | Language code for instructions (e.g., 'en-US', 'de-DE'). | |
| maxAlternatives | No | Number of alternative routes (0-5). More alternatives = more options but larger response. | |
| maxChargeInkWh | No | Maximum EV battery capacity in kWh. Required for EV routing. | |
| recuperationInkWhPerkmAltitudeLoss | No | Energy recovered per km of altitude loss. | |
| report | No | Specifies which data should be reported for diagnostic purposes. A possible value is: `effectiveSettings`. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters, the default will be reflected where the parameter was not specified by the caller. Default value: effectiveSettings | |
| routeRepresentation | No | Representation of routes in response: 'polyline' (default, includes points), 'encodedPolyline' (compressed format), 'summaryOnly' (no points), 'none' (with computeBestOrder only). It cannot be used when `maxAlternatives` is set | |
| routeType | No | Route optimization: 'fastest' (time-optimized), 'shortest' (distance-optimized), 'eco' (fuel-efficient), 'thrilling' (scenic). | |
| sectionType | No | Road section types to highlight for route analysis. Options: toll (toll roads), motorway (highways), tunnel, urban (city areas), country (rural areas), pedestrian (walking paths), traffic (traffic incidents), toll_road, ferry, travel_mode, important_road_stretch. Accepts array of string(s). | |
| supportingPoints | No | Additional coordinates that influence the route shape without being stops (format: 'lat,lon;lat,lon'). | |
| traffic | No | Include real-time traffic data for more accurate ETAs and route suggestions. | |
| travelMode | No | Transportation mode. Default: 'car'. | |
| uphillEfficiency | No | Efficiency during uphill driving (0-1). | |
| vehicleAdrTunnelRestrictionCode | No | ADR tunnel restriction code for hazardous materials. | |
| vehicleAxleWeight | No | Vehicle axle weight in kg for weight-restricted roads. | |
| vehicleCommercial | No | Commercial vehicle flag. Affects road access restrictions. | |
| vehicleEngineType | No | Engine type for fuel/energy consumption calculation. | |
| vehicleHeading | No | Heading of the vehicle in degrees (0-359) for more accurate initial routing. | |
| vehicleHeight | No | Vehicle height in meters. Used to avoid low bridges. | |
| vehicleLength | No | Vehicle length in meters. Affects maneuverability restrictions. | |
| vehicleLoadType | No | Cargo type for hazardous materials routing. | |
| vehicleMaxSpeed | No | Maximum vehicle speed in km/h for commercial routing. | |
| vehicleNumberOfAxles | No | Number of axles on the vehicle. Used for toll calculations and restrictions. | |
| vehicleWeight | No | Vehicle weight in kg. Important for truck routing restrictions. | |
| vehicleWidth | No | Vehicle width in meters. Used to avoid narrow roads. | |
| waypoints | Yes | Ordered array of waypoint coordinates (minimum 2). Route calculated in exact sequence provided. Use geocoding for accurate coordinates. | |
| windingness | No | Preference for avoiding winding roads. Use 'low' for straighter routes. |