For AI agents: visit https://docs.here.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
- HERE Routing API v8 Release Notes
- Changes
API changes
- Added
currencyUnsupported notice code
- Added
ev[auxiliaryPowerCurve] support for empirical consumption model
- Added
auxiliaryEnergyConsumption for via waypoints.
- Waypoints with
charging info can't use auxiliaryEnergyConsumption.
- Extended support of
networkRestrictedTruck[permittedNetworks] to include Australia (AUS)
- Updated
networkRestrictedTruck[permittedNetworks] parameter to allow for inclusion of states
- Added
state field in networkRestrictedTruck[permittedNetworks] parameter in POST
- Error
E605501 with 429 HTTP error code is returned for the route import request when the service is under a high load and request should be retried after a little while.
- Added
networkRestrictedTruck transport mode
- Added
networkRestrictedTruck[permittedNetworks] parameter (also in POST body)
- Added
permittedNetworks span type
- Deprecated
avoid[features]=difficultTurns.
- Added missed transit notices:
violatedBlockedRoad, violatedVehicleRestriction, currentWeightExceedsLimit.
- Added
hovAttributes to spans parameters and response.
- Added
KeepAction to PedestrianAction to reflect currently existing behaviour.
- Updated
vehicle[commercial] to also affect speed limits and route choice in car mode.
- Updated the references to the HERE Charge Point API to point to the new version of the service.
- removed
DeboardAction from VehiclePostAction and PedestrianPostAction as it can only appear in TransitPostAction
- changed
roundaboutExit action definition in VehicleAction from TurnAction to ExitAction, as it was incorrect.
- Added
ev[auxiliaryPowerCurve] parameter.
- Limit for
stopDuration now applies to all requests.
- Added
ev[excludechargepointoperators] parameter.
- Removed mutual exclusive behaviour for
ev[preferredChargePointOperators] and ev[eMobilityServiceProviderPreferences] parameters.
- Added a new value
SAE_J3400 and deprecated Tesla in ev[connectorTypes] parameter.
- Removed brand_only restricted stations.
- Added
ev[airDensity] parameter.
- Adjusting country limitations for
ev[makeReachable] with transportMode[truck].
- Added
vehicle[emptyWeight] parameter.
- Prioritize vehicle[grossWeight] over vehicle[currentWeight] when evaluating allowCarChargingStations
vehicle[shippedHazardousGoods] is now supported in combination with ev[makeReachable]=true
- Removed support for unused content type
application/geo+json in route import request.
- Added limits for
chargingSetupDuration, chargingCurve, stopDuration, maxCharge, airDragCoefficient, rollingResistanceCoefficient, maxChargingVoltage and maxChargingCurrent parameters in ev.
- Added notice detail
ViaNoticeDetail to response notice in case a via waypoint fails to match
- Update and improve description for
return.
- Added
maxTiresCount to VehicleRestriction
- Renamed parameter
vehicle[speedCapPerFrc] to vehicle[speedCapPerFc].
- Added support for the unknown railway crossing type.
- Added limitation of
driver[schedule] being valid only for truck, bus and privateBus modes.
- Added
vehicle[speedCapPerFrc] parameter.
- Added notices for violation of charging station restrictions for
transportMode and vehicle attributes.
- Added
maxChargingDuration in ev. This allows to limit charing duration on all charging stations.
- Notices for route handle with
currentWeightChange without vehicle[currentWeight] or vehicle[grossWeight].
- Beta release of support for
ev[makeReachable] with transportMode[truck].
- Using waypoints
currentWeightChanges requires both vehicle[currentWeight] and vehicle[grossWeight].
- Added
allowCarChargingStations in ev . This allows trucks under 7.5T to use car charging stations.
- Added enum for notice code
vehicleRestriction in TransitNotice.
- Added parameter
maxPowerAtLowVoltage to change capping of power at low voltage stations for vehicles with maxChargingVoltage >= 800 V.
- Weight dependent routing zone restriction notice updated to return
maxWeight.
- Clarification for
avoid[zoneCategories] and avoid[zoneIdentifiers] added.
- License plate restriction violation notice updated to return the restricted pattern
licensePlateRestriction.
- Beta label removed from the
transportMode=taxi mode and taxi[*] parameter
- Clarify default behavior of the
vehicle[occupancy] parameter
- Removed the 300 km limitation for
makeReachable with avoid controlledAccessHighway, tollRoad or tollTransponders options in car mode. Note that when we release support for truck mode with makeReachable, it will likely come with this limitation.
- Use
vehicle[trailerCount] for restrictions during route calculation, but not for speed limits
- Added support for
notices in spans for transit sections (TransitSpan).
- Updated maximum limit of
vehicle[currentWeight] for car and taxi transport modes.
- Added
currentWeightChange for via waypoints.
- Expanded country list supporting state exclusions (
exclude[states])
- Error
E605029 returned if state code not supported in exclude[states]
- Adapted
routeLabels API to fit the service response
- Fixed support for
exclude.area in the POST body
- Description updates and additional error codes for
driver[schedule] usage.
- adding mention to api that
pedestrian and bicycle transportModes are not supported with ev/fuel parameters
- adding error code for using
pedestrian/bicycle with ev/fuel parameters
- adding
charge into the TransitDeparture, since we are already returning it
- Added
vehicle[commercial] to let users specify whether they are a commercial vehicle for toll costs.
- Evaluate reachability of EV routes and return the following notices in case conditions are not met
- violatedMinChargeAtDestination
- violatedMinChargeAtFirstChargingStation
- violatedMinChargeAtChargingStation
- outOfCharge
- Added
exclude[areas] parameter
- Added
exclude[states] parameter
- An invalid country or state code in
exclude[states] will trigger error E605025 for country codes and E605026 for state codes.
- Update links to help portal.
- Added support for traffic
intersectionIncidents in spans.
- (beta)
vehicle parameters are supported for car and taxi.
- Deprecated
sections[*].tolls[*].fares[*].name property and updated descriptions.
- Combined usage of incompatible parameters
radiusPenalty and snapRadius will cause an error with error code E605023.
- Range for
radiusPenalty increased to [0..10000]. Conditions apply. Unsupported values for the parameter cause an error with error code E605022.
- Charging stations restricted to brand only access are now considered when using
makeReachable and one of their E-Mobility Service Provider ids is specified in the eMobilityServiceProviderPreferences parameter.
- Added new error
E605077 for out-of-range rerouting[lastTraveledSectionIndex].
- Added
noThroughRestrictions to return parameters.
- Added
noThroughRestrictions to span parameters and response.
- Added
noThroughRestrictions to sections section in response.
- Increased the number of allowed "Penalized segments" to 1000.
- Added support for GB/T EV connector.
- Added
maxWeight to VehicleRestriction and deprecated maxGrossWeight.
- Description updates for fuel types and carbon dioxide emission.
- Added option to specify a charging station details on
via waypoints.
- Added physical consumption model
vehicle namespace parameter axleCount added car and taxi mode, only for toll calculations.
- reinstated toll system id in response, but is now deprecated.
- Added
vehicle[currentWeight]
- Clarified weight per axle group description
- Bug fixes related to OpenAPI deserialization and validation errors. See Resolved Issues section for more details.
vehicle namespace now has some parameters open for car and taxi mode. Currently, support in these modes is only extended for toll calculations.
- added
transponders under fares
TollCost updated to support multiple systems. New property tollSystems added, tollSystemRef deprecated.
- removed id from TollSystem response
- added eMobilityServiceProviderPreferences parameter to the route handle requests
- add
vehicle[heightAboveFirstAxle] to allow for more accurate toll costs. It only affects toll costs
- Added
applicableTimes under fares
- added
uTurnPermission under waypoint place options to specify u-turn permission for individual stop-over waypoints
- Updated
vehicle[occupancy] description
- Deprecated
vehicle[hovOccupancy]
- Added
display_location in Waypoints
- added
ViolatedChargingStationOpeningHours under VehicleNoticeDetail
- Updated handling of
rerouting[lastTraveledSectionIndex]
- Re-include
violatedChargingStationOpeningHours description
- Update
tolls[emissionType] description.
- Added
ev[preferredChargePointOperators] and ev[eMobilityServiceProviderPreferences] parameters, also added suport of ev.preferredChargePointOperators parameter in POST body
- Added
tollsDataTemporarilyUnavailable notice code
- Number of points allowed in
avoid[area] type polygon and corridor increased to 100
- Moved
payloadCapacity from truck to vehicle namespace (documentation only).
- Parameter
tolls[emissionType] updated to support CO2 emission class co2class.
- Added
avoidTruckRoadTypesInvalidId info notice for the case when the provided truck road type id was not found
- Add additional return option for returning potential violated time-dependent restrictions by requesting
return=potentialTimeDependentViolations
- Add
TransitAction to TransitSection. Fixes parsing of "actions" in transit sections using auto-generated clients.
- Add support exceptions for avoid areas
- Add support for opening hours for EV charging stations.
violatedChargingStationOpeningHours critical notice is returned on the section if the planned stop (including charging up to target level) falls outside these times.
- Added
ev[excludeChargingStations] parameter
- Capped the value of
minCourseDistance for PlaceOptions to 2000m
- Removed
violatedAvoidZone notice code
- Added
vehicle[engineType] parameter
- (beta) Added new available options for
fuel[type] (lng, ethanol, propane, hydrogen)
- Toll calculations now consider
vehicle[engineType] and fuel[type] (only when data coverage is available)
- Emission factors for Diesel fuel have been adjusted.
- Hazardous material cargo is taken into account for toll calculation
- Add
category to Routing Zone response.
- Updated
forbiddenHazardousGoods property in API specification to match implementation.
- Maintenance update for api-specs and descriptions.
- Clarify coordinate system of polygons and polylines.
- Add examples for various items
- Added new
violatedAvoidTruckRoadType and violatedAvoidZone notices
violatedZoneRestriction notices now can report which zone was violated
- Added
railwayCrossings to spans parameters and response
- Added
gates to spans parameters and response
- Added more documentation about notice references in
spans
- Add missing
builtUpArea StreetAttribute attribute
- Slight changes to sentence structures
- Fixed the notice for violating
allow[hov] and allow[hot] parameters
- Added
builtUpArea to spans[streetAttributes]
- Added
vehicle[payloadCapacity] parameter
- Added
allow[hov] parameter
- Added
allow[hot] parameter
- Added
routeType for LocalizedRouteNumber
- Fixed name of
tollSystem member in response
- Updated the behaviour of
lang parameter.
- Empty
nameHint waypoint parameters are ignored
- Added
traffic[mode] parameter
- Added
vehicle[kpraLength] parameter
- Added
radiusPenalty parameter to waypoint places
- Fixed the notice for violating weight per axle group restrictions
- Added axle groups
quad and quint for input
- Fixed incorrect unit for
ascent in api reference documentation
- Added
restrictedTimes for time dependent restrictions.
- Parameter
vehicle[engineSizeCc] marked as alpha
- Parameter
vehicle[occupancy] marked as alpha
- Deprecation mark removed from
vehicle[hovOccupancy] parameter
- Returning route numbers as
LocalizedRouteNumber type
- Added
vehicle[engineSizeCc] parameter
- Added
vehicle[occupancy] parameter
- Deprecated
vehicle[hovOccupancy] parameter
- (beta) Introducing
fuel for calculating consumption and related CO2 emission for fuel based vehicles.
- Added
turnAngle to turn-by-turn actions
- Added
roundaboutTurnAngle to turn-by-turn actions
- Added
driver[schedule] parameter
- Added
signposts to turn-by-turn actions
- Fixed importSplitRoute notice for /import request
- Added support for
mlDuration for transportMode=taxi
- Added new supported shape format
polygon to avoid[areas] parameters
- Added
stateCode to spans parameters
- Added
routeLabels return option
- Allow avoid u-turn for the transport modes car, taxi, and bus in addition to truck. It remains forbidden for pedestrian, bicycle, and scooter.
- Added
snapRadius parameter to waypoint places
- Parameter
lang accepts list of languages.
- Added a new notice code
MainLanguageNotFound at response level.
- Added
id parameter to incident section of response
- Added notice details type
violatedTransportMode for violatedVehicleRestriction notice code.
- Added
segmentIdHint parameter to waypoint places
- Added
vehicle[tiresCount] parameter
- Added
vehicle[trailerAxleCount] parameter
- Added
onRoadThreshold option to waypoint parameter
- Enabled
vehicle[speedcap] parameter for ev option ev[makeReachable]=true
- Toll information now returns
FarePass information in case there are options for multi-travel pass
- Added 250 items limit for
avoid[areas] parameter
- Added
ev[minChargeAtFirstChargingStation] option
- Increased route import tracepoints limit to 50000 points
- Added
segmentId and segmentRef to transit spans
- Enabled
exclude[countries] parameter for ev option ev[makeReachable]=true
- Removed
E605044 error code
- Added a new parameter
tolls[emissionType]
- Added a new error
routeLengthLimitExceeded
- Updated documentation with respect to vehicle, transit and pedestrian section notices
- Added a new parameter
tolls[vehiclecategory] and tolls vehicle category minibus.
- Some avoid options are now enabled in combination with makeReachable parameter (for EV routing).
- Toll information is available via
return=tolls, spans=tollSystems and tolls parameters namespace
- Error reporting for avoid u-turns and truck category lightTruck combination
- Added notice with code unknownParameter in case unknown parameters
- Added
noReachableChargingStationsFound error code
- Route handle and import return a route with a notice on section level with code
violatedVehicleRestriction in case motorized vehicle (car, truck, bus, etc) is on restricted but open for motorized vehicle segment (e.g truck on car only segment).
- Added
avoid[uTurns] to allow users to avoid difficult or U turns as per need
- Added
via to import traces
- Added an error code
E605053 for rejecting via with invalid indexes
- Added
refReplacements to pedestrian section
- Rejecting
routingZones for pedestrian transport mode with E605302, E605303
- Rejecting
truckRoadTypes for pedestrian transport mode with E605304
- Added
taxi[allowDriveThroughTaxiRoads] parameters.
- Added an error code,
E605048, for the unsupported parameter combination of avoid[features]=difficultTurns and truck[category]=lightTruck.
- Added
arrivalTime based routing with via waypoints
- Added
truck[weightPerAxleGroup] parameter to allow more fine-grained specification of axle weights
- Added
ev.preferredBrands parameter in POST body
- Added
tollsDataUnavailable and chargingStopNotNeeded notice codes
- Added
truck[category] parameter
- Added
tollTransponder notice code
- Alpha label removed from
routeHandle
- Added
vehicle[licensePlate] parameter.
- Added
typicalDuration to return parameters
- Added
typicalDuration to spans parameters
- Added
avoid[tollTransponders]=all request parameter
- Added
violatedAvoidTollTransponder notice code
- Added
violatedAvoidSeasonalClosure and seasonalClosure notice codes
- Added
rerouting[mode] request parameter for /routes/ with routeHandle
- Added
returnToRoute notice
- Added
intersectionName attribute to TurnAction
- Added
tolls return parameter for /routes/
- Added
currency parameter to requests
- Support POST request method for
/routes/ endpoint
- Added
avoid.segments parameter in POST body
- Enabled response compression (HTTP Content-Encoding)
- Beta label removed from EV Routing
- Return street names in all available languages
- Added optional
origin parameter to getRoutesByHandle
- Added support for route import (alpha):
- Allows to create a route from a sequence of trace points.
- Added
avoid[segments] parameter
- Added notice about invalid segment id in route response
- Added notice about invalid zone id in route response
- Added
congestionPricing to routing zone category avoidance ( avoid[zoneCategories] parameter)
- Added a notice for using emergency gates
- Added
notices as an option for spans parameter. This can be used to get the actual locations of violated restrictions in truck routing.
- Notices informing about violated restrictions have been moved. Information about what types of restrictions could not be avoided is now available in notices on
section level, within route, instead of top level notices. This was driven by a change in handling truck restrictions - see "Functional and Behavioral Changes".
- Added brand attribute to ChargingStationPlace
- Added (Alpha )
taxi and bus routing modes
- Added
routingZones to returns parameters
- Added
routingZones to spans parameters
- Added
ev[preferredBrands] parameter
- Added
avoid[zoneIdentifiers] parameter
- Added
avoid[zoneCategories] parameter
- Added
board preAction and deboard postAction to transit section
- Added
maxSpeed to vehicle span in response.
- Deprecated span type
speedLimit
- Added support for
mlDuration for car routing
- Add span type
segmentRef that replaces segmentId. segmentRef contains more information about the given segments, such as catalog HRN and catalog version. It will also be used by other services.
- Add
truckAttributes, scooterAttributes, incidents, and segmentId to pedestrian spans to align them more closely with vehicle spans
- Add
walkAttributes to vehicle spans to align them more closely with pedestrian spans
- Speed cap feature now available for car, truck and scooter
- Added
vehicle[speedCap] parameter.
- Added support for highway usage for scooter routing.
- Added
scooter[allowHighway] parameter.
- Added
X-Request-Id request and response header parameters for request tracing.
- Added
exitSign attribute to OffsetAction.
- Added
toward atribute to RoadInfo used for turnByTurnActions.
- Added support for scooter routing.
- Added
truck[type] and truck[trailerCount] parameters.
- Added new notice code
violatedTimeDependentRestriction.
- Introducing bicycle routing in OLS.
- Add length to
OffsetActions
- Added support for 2 new types of EV connectors (Chademo and Tesla)
- Improved documentation of
units param.
- Add support for traffic
incidents in sections and spans.
- Fix unsupported
routingMode param from route handle endpoint (removed).
- New notice about violated transport mode during route handle decoding.
- Added floating point
pedestrian[speed] parameter.
- Rejecting
pedestrian[speed] for non-pedestrian 'transportMode' with E605301
- Breaking beta change: added a mandatory parameter
ev[connectorTypes] to ev[makeReachable] option.
- Added support for all parameters from
/routes for /routes/{routeHandle} endpoint, except
for parameters origin, destination, via, alternatives, and routingMode.
- Breaking alpha change:
/routes/{routeHandle} endpoint has now an obligatory parameter
transportMode similarly to /routes endpoint.
- Added boolean
passThrough parameter via waypoints.
- Added note stating that
passThrough is not supported for origin and destination waypoints.
- Added note stating that
passThrough is not supported in conjunction with stopDuration.
- Rejecting invalid
routeHandle with E605201
- Listing currently used notice codes in the API schema
- Clarified
stopDuration parameter on destination and via waypoints. Added a note that
stopDuration is not supported for origin waypoint.
- Added wait action generated for waypoints with waiting time (e.g. when
stopDuration is set or
charging is needed).
- Added support for routing over Express/High-Occupancy Vehicle (HOV) lanes. See
vehicle[] parameter.
- Added support for route handles (alpha):
- Allows to encode routes during calculation by setting
return=routeHandle. The result is
stored in routes[].routeHandle property.
- New endpoint
/routes/{routeHandle} which decodes and returns a route from a previously
calculated route handle.
- Added additional versions to
version response: serviceVersion and dataVersions
- Added
language of localized strings at the section response level
- Added
areas to avoid request parameter.
- Added
elevation value for return parameter.
- Rename version to
8.1.0 without changing the API.
- Added
/v8/* paths.
- Deprecated
/v1/* paths.
- Added advanced waypoint options to
origin, destination and via request paramaters.
- Added
originalLocation to departure and arrival field in the section response.
- Added
turnByTurn actions to response for usage in visual or voice guidance.
- Added
duration and baseDuration to vehicle span in response.
- Added
baseDuration to the vehicle summary in response.
- Added
exclude request parameter supporting excluding coutries.
- Removed default value from required request parameter
transportMode.
- Extended the documentation of error codes returned by the service.
