tomtom-reachable-range
Calculate reachable areas based on time, distance, or energy budgets for vehicles. Input coordinates, travel mode, and optional constraints like traffic or route preferences to generate accurate routing insights.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accelerationEfficiency | No | Efficiency during acceleration (0-1). | |
| 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. | |
| 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'). | |
| distanceBudgetInMeters | No | Maximum travel distance in meters. Examples: 5000 (5km), 10000 (10km), 20000 (20km). Either time or distance budget required. | |
| downhillEfficiency | No | Efficiency during downhill driving (0-1). | |
| energyBudgetInkWh | No | Maximum energy budget in kWh for electric vehicles. Example: 10 (10 kWh). | |
| fuelBudgetInLiters | No | Maximum fuel budget in liters for combustion vehicles. Example: 5 (5 liters). | |
| fuelEnergyDensityInMJoulesPerLiter | No | Fuel energy density in megajoules per liter. | |
| hilliness | No | Preference for avoiding hills. Use 'low' for flatter routes. This can be only used when `routeType` parameter is set to `thrilling`. | |
| maxChargeInkWh | No | Maximum EV battery capacity in kWh. Required for EV routing. | |
| maxFerryLengthInMeters | No | Maximum allowed ferry length in meters. | |
| origin | Yes | Starting point for reachable area calculation. Typically current location or point of interest. | |
| 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 | |
| routeType | No | Route optimization: 'fastest' (time-optimized), 'shortest' (distance-optimized), 'eco' (fuel-efficient). | |
| timeBudgetInSec | No | Maximum travel time in seconds. Examples: 900 (15min), 1800 (30min), 3600 (1h). Either time or distance budget required. | |
| traffic | No | Include real-time traffic data for more accurate reachable area calculation. | |
| travelMode | No | Travel mode affects reachable area shape. Default: 'car'. Note: Pedestrian/bicycle modes not supported by API. | |
| 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. | |
| 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. | |
| windingness | No | Preference for avoiding winding roads. Use 'low' for straighter routes. This can be only used when `routeType` parameter is set to `thrilling`. |