TomTom Reachable Range
tomtom-reachable-rangeDetermine the reachable area from a starting point within a specified time, distance, or fuel budget, considering traffic, route type, and vehicle restrictions.
Instructions
Determine the area reachable within a specified time or driving distance
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| avoid | No | Route features to avoid. May increase travel time. Options: 'tollRoads','motorways','ferries','unpavedRoads','carpools','alreadyUsedRoads'. Accepts array of string(s). | |
| origin | Yes | Starting point for reachable area calculation. Typically current location or point of interest. | |
| 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 | |
| traffic | No | Include real-time traffic data for more accurate reachable area calculation. | |
| departAt | No | Departure time in ISO format (e.g., '2025-06-24T14:30:00Z'). | |
| hilliness | No | Preference for avoiding hills. Use 'low' for flatter routes. This can be only used when `routeType` parameter is set to `thrilling`. | |
| routeType | No | Route optimization: 'fastest' (time-optimized), 'shortest' (distance-optimized), 'eco' (fuel-efficient). | |
| travelMode | No | Travel mode affects reachable area shape. Default: 'car'. Note: Pedestrian/bicycle modes not supported by API. | |
| windingness | No | Preference for avoiding winding roads. Use 'low' for straighter routes. This can be only used when `routeType` parameter is set to `thrilling`. | |
| vehicleWidth | No | Vehicle width in meters. Used to avoid narrow roads. | |
| vehicleHeight | No | Vehicle height in meters. Used to avoid low bridges. | |
| vehicleLength | No | Vehicle length in meters. Affects maneuverability restrictions. | |
| vehicleWeight | No | Vehicle weight in kg. Important for truck routing restrictions. | |
| maxChargeInkWh | No | Maximum EV battery capacity in kWh. Required for EV routing. | |
| response_detail | No | Response detail level. 'compact' (default): returns center point only, boundary coordinates are trimmed — the MCP App still renders the full reachable range polygon. 'full': includes boundary coordinates in the response, use this when you need to plot or process the boundary data yourself. | compact |
| timeBudgetInSec | No | Maximum travel time in seconds. Examples: 900 (15min), 1800 (30min), 3600 (1h). Use ONLY ONE budget parameter — do not combine with other budget types. | |
| vehicleLoadType | No | Cargo type for hazardous materials routing. | |
| vehicleMaxSpeed | No | Maximum vehicle speed in km/h for commercial routing. | |
| uphillEfficiency | No | Efficiency during uphill driving (0-1). | |
| energyBudgetInkWh | No | Maximum energy budget in kWh for electric vehicles. Example: 10 (10 kWh). REQUIRED companions: vehicleEngineType='electric', constantSpeedConsumptionInkWhPerHundredkm, currentChargeInkWh, maxChargeInkWh. Use ONLY ONE budget parameter — do not combine with other budget types. | |
| 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. | |
| auxiliaryPowerInkW | No | Auxiliary power consumption in kW for electric vehicles. | |
| chargeMarginsInkWh | No | Comma-separated charge margins in kWh for route planning. | |
| currentChargeInkWh | No | Current EV battery charge in kWh. Required for EV routing. | |
| downhillEfficiency | No | Efficiency during downhill driving (0-1). | |
| fuelBudgetInLiters | No | Maximum fuel budget in liters for combustion vehicles. Example: 5 (5 liters). REQUIRED companions: vehicleEngineType='combustion' and constantSpeedConsumptionInLitersPerHundredkm (e.g. '50,6.5:130,11.5'). Use ONLY ONE budget parameter — do not combine with other budget types. | |
| currentFuelInLiters | No | Current fuel level in liters for combustion vehicles. | |
| vehicleNumberOfAxles | No | Number of axles on the vehicle. Used for toll calculations and restrictions. | |
| accelerationEfficiency | No | Efficiency during acceleration (0-1). | |
| decelerationEfficiency | No | Efficiency during deceleration (0-1). | |
| distanceBudgetInMeters | No | Maximum travel distance in meters. Examples: 5000 (5km), 10000 (10km), 20000 (20km). Use ONLY ONE budget parameter — do not combine with other budget types. | |
| maxFerryLengthInMeters | No | Maximum allowed ferry length in meters. | |
| auxiliaryPowerInLitersPerHour | No | Auxiliary power consumption for combustion vehicles in L/hr. | |
| vehicleAdrTunnelRestrictionCode | No | ADR tunnel restriction code for hazardous materials. | |
| consumptionInkWhPerkmAltitudeGain | No | Energy used per km of altitude gain. | |
| fuelEnergyDensityInMJoulesPerLiter | No | Fuel energy density in megajoules per liter. | |
| recuperationInkWhPerkmAltitudeLoss | No | Energy recovered per km of altitude loss. | |
| constantSpeedConsumptionInkWhPerHundredkm | No | EV speed-to-consumption mappings format: '50,8.2:130,21.3' (speed in km/h, consumption in kWh/100km). | |
| constantSpeedConsumptionInLitersPerHundredkm | No | Combustion speed-to-consumption mappings: '50,6.3:130,11.5' (speed in km/h, consumption in L/100km). |