HERE Routing API
The Routing API from HERE — 3 operation(s) for routing.
HERE Routing API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Routing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 3 paths, and defines 277 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://transit.hereapi.com/v8, https://router.hereapi.com/v8.
5 operations
3 paths
277 schemas
2 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
HERE Routing API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as apiKey (ApiKey).
It accepts HTTP bearer tokens (JWT) (Bearer).
By default, every request must be authenticated.
ApiKey— A key generated specifically to authenticate API requests. For more information on how to get an API key, see [Identity and Access Management Developer Guide](…Bearer— A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bearer to…
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Routing 5
GET
/routes
Routes
POST
/routes
Calculate routes via POST
GET
/routes/{routeHandle}
Get route by handle via GET
POST
/routes/{routeHandle}
Get route by handle via POST
POST
/import
Calculate a route from a sequence of trace points
Schemas 277
The contract defines 277 schemas that model the data the API accepts and returns. The most detailed are VehicleSpan (32 properties), Truck (31 properties), Vehicle (31 properties), VehicleRestriction (27 properties). Each schema is shown below with its type and property counts.
TransitMode
string
Extensible enum: highSpeedTrain intercityTrain interRegionalTrain regionalTrain cityTrain bus ferry subway lightRail privateBus inclined aerial busRapid monora…
RangePrice
object
6 properties
4 required
Duration
integer
Duration in seconds.
TransitModesFilterItem
TravelSummary
object
Total value of key attributes for a route section.
2 properties
2 required
TransitStop
object
A transit stop of the route.
5 properties
1 required
Units
string
Units of measurement used, for example, in guidance instructions. The default is metric.
PedestrianSpan
object
Span attached to a Section describing pedestrian content.
4 properties
TimeRestrictedPrice
object
10 properties
3 required
TimeRestrictedWeekdays
string
TransitStopAttributes
string
Extensible enum: noEntry noExit ... Attributes of a stop. noEntry: The transport cannot be entered at the stop. noExit: The transport cannot be exited at the s…
TransitPostAction
ChargingConnectorAttributes
object
Details of the connector that is suggested to be used in the section's postAction for charging.
5 properties
3 required
TransitRoute
object
A basic transit routing response. It may include transit and walk sections.
3 properties
2 required
ArriveAction
object
An arrival maneuver to be performed at or during a specific portion of a section.
5 properties
2 required
TransitRouteResponse
object
Returns a list of routes.
2 properties
1 required
Distance
integer
Distance in meters.
Color
string
ServiceTimes
object
The first and last trip time for the transit route at the stop on a given day. Only present for the departure stop of a transit section. NOTE: serviceTimes is…
2 properties
ErrorResponse
object
Response in case of error
6 properties
6 required
WalkAttributes
string
Extensible enum: indoor ... WalkAttributes are applied to a span of a route section and describe walk-related attribute flags. indoor: This part of the route i…
DockingStationPlace
A place represents a docking station for rented vehicles.
SimpleErrorResponseSchema
object
2 properties
TransitIncident
object
An incident describes disruptions on the transit network. Disruptions scale from delays to service cancellations.
7 properties
2 required
BoardAction
object
An action to board a ferry.
3 properties
2 required
TransitModeExcluded
string
Extensible enum: -highSpeedTrain -intercityTrain -interRegionalTrain -regionalTrain -cityTrain -bus -ferry -subway -lightRail -privateBus -inclined -aerial -bu…
Place
A place represents a generic location relevant for the route.
ChargingStationPlace
object
A charging station
7 properties
2 required
FarePrice
Price of a fare
ParkingLotPlace
object
A parking lot
7 properties
2 required
Time
string
RFC 3339, section 5.6 as defined by either date-time or date-only 'T' partial-time (ie no time-offset).
ExitAction
object
An action to leave a highway or roundabout. exit: exit maneuver, such as "Take the left exit to" roundaboutExit: roundabout exit maneuver, such as "Take the th…
8 properties
2 required
StationPlace
object
A station
8 properties
2 required
TransitModesFilter
array
Transit type filter used to determine which types of transit to include in the response. By default, all supported transit types are permitted. Mixing of inclu…
PedestrianAction
Action attached to a pedestrian section.
DeparturePlatform
string
Platform name or number for the departure.
Location
object
Location on the Earth
2 properties
2 required
TransitIncidentEffect
string
Extensible enum: cancelledService reducedService additionalService modifiedService delays detour stopMoved other ... An open list of possible incident effects.…
TransitSection
object
A section of the route. It contains departure, arrival, and route information.
18 properties
4 required
DepartAction
object
A departure maneuver to be performed at or during a specific portion of a section.
5 properties
2 required
TransitAgency
object
Contains information about a particular agency.
4 properties
2 required
BaseRoutablePlace
object
4 properties
2 required
Uri
string
An URL address that links to a particular resource.
PartialTime
string
RFC 3339, section 5.6 as defined by partial-time.
DepartureStatus
string
Extensible enum: scheduled cancelled additional replaced ... Status of the departure scheduled: A trip that is running as planned in the schedule. cancelled: A…
PedestrianDeparture
object
Departure of pedestrian
2 properties
1 required
TransitTransport
object
Transit transport information.
10 properties
1 required
TransitIncidentType
string
Extensible enum: technicalProblem strike demonstration accident holiday weather maintenance construction policeActivity medicalEmergency other ... An open list…
PedestrianPostAction
SimpleTurnAction
object
Turn maneuver, such as "Make a sharp right turn at"
7 properties
2 required
NoticeSeverity
string
Describes the impact a notice has on the resource to which the notice is attached. critical - The notice must not be ignored, even if the type of notice is not…
PedestrianSpeed
number
Pedestrian speed in meters per second
PedestrianPlace
Place used in pedestrian routing
ChargingStationBrand
object
Information regarding the charging station brand
2 properties
OffsetAction
object
An action to be performed at or during a specific portion of a section.
5 properties
2 required
TurnActionSeverity
string
Tightness of the turn. Optional in the turn action, unused by other actions. light: indicates making a light turn quite: indicates making a regular turn heavy:…
SectionTransitDeparture
object
Transit departure
5 properties
1 required
SinglePrice
object
5 properties
3 required
Polyline
string
Line string in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) format. Coordinates are in the WGS84 coordinate system, including Elevation (…
AccessPointPlace
object
Access point to a venue/station
5 properties
2 required
TransitDeparture
object
Transit departure
4 properties
1 required
TransitPreAction
An action that must be done prior to departure.
ParkingLotPlaceType
string
Extensible enum: parkAndRide ... Currently possible values are: parkAndRide - this parking lot is of type "Park and Ride", such as it is a parking specifically…
ContinueAction
object
A continue operation to be performed at or during a specific portion of a section.
5 properties
2 required
DepartureDelay
integer
The accumulated delay in seconds from the scheduled time of the event.
Notice
object
A notice contains important notifications.
3 properties
1 required
ChargingConnectorType
string
Extensible enum: iec62196Type1Combo iec62196Type2Combo chademo tesla saeJ3400 gbtDc unknown ... Currently supported connector types are: iec62196Type1Combo: Ty…
DeboardAction
object
An action to disembark a ferry.
3 properties
2 required
SourceFeedMapping
object
Mapping of the internal data returned in the respone to the data from the source feed. A type will only be returned if the source feed data has a match. Each t…
2 properties
Attribution
object
The URL address to an external resource.
5 properties
2 required
TransitRouteSection
A transit or pedestrian section of the route.
PedestrianMode
string
Extensible enum: pedestrian ... Pedestrian mode of transport. Since the supported pedestrian modes may be extended in the future, the pedestrian mode should be…
PedestrianNotice
object
A notice contains important notifications.
3 properties
1 required
AttributionLinkType
string
Attribution link type. disclaimer - Page with further legal information from the agency. tariff - Page with information on the tariff.
WheelchairAccessibility
string
Defines accessibility for people with a disability and who use a wheelchair. unknown - Information is not available. yes - Full unrestricted accessibility. lim…
Fare
object
"Fare type contains information about a single fare or ticket needed for this section of the route." NOTE: Fares information support will be available soon.
4 properties
3 required
BaseDepartureDetails
object
Defines a departure where the departure stop is implicit (e.g. station board departures).
5 properties
1 required
PedestrianSection
object
Represent a section of a route
12 properties
5 required
PedestrianTransport
object
Information about a transport.
1 property
1 required
TransitNotice
object
A notice contains important notifications.
3 properties
1 required
LocationString
string
ChargingSupplyType
string
Extensible enum: acSingle acThree dc ... Currently possible values are: acSingle : Single phase Alternating Current supply acThree: Three phase Alternating Cur…
BaseAction
object
An action to be performed between sections or during a section.
3 properties
2 required
KeepAction
object
Keep maneuver, such as "Take the middle fork onto"
7 properties
2 required
WebLinkWithDeviceType
object
The URL address to an external resource.
5 properties
2 required
TurnActionDirection
string
Direction of the turn. middle is only used by the keep action.
RoundaboutAngle
number
The degree measure of the arc traversed from the roundabout entrance to the exit of the maneuver. Available only for exit roundabout actions. Positive values i…
TransitMode_2
string
Extensible enum: highSpeedTrain intercityTrain interRegionalTrain regionalTrain cityTrain bus ferry subway lightRail privateBus inclined aerial busRapid monora…
RailwayCrossing
string
Extensible enum: protected unprotected unknown ... Type of railway crossing.
RoutingZoneReference
string
A reference to a routing zone in HMC. The standard representation of a routing zone reference has the following structure: {catalogHrn}:{catalogVersion}:({laye…
TransponderSystem
object
Transponder system for which a fare is applicable.
1 property
EVPhysicalModel
object
Specifies parameters required for calculation of energy consumption for electric vehicles using physical model.
20 properties
2 required
PolygonArea
object
A polygon defined as a list of coordinates. The polygon is automatically closed, so repeating the first vertex is not required. Self-intersecting polygons are…
2 properties
2 required
WebLink
object
The URL address to an external resource.
4 properties
2 required
Gate
string
Extensible enum: keyAccess permissionRequired emergency ... Type of gate crossing.
TransitStop_2
object
A transit stop of the route
5 properties
1 required
PedestrianSpan_2
object
Span attached to a Section describing pedestrian content.
24 properties
CO2Emission
number
Estimation of the carbon dioxide emission for the given route section. Unit is kilograms with precision to three decimal places. Definitions: Total Emission (W…
TransitTurnByTurnAction
TunnelCategory
string
Specifies the tunnel category used to restrict the transport of specific goods.
Spans
string
TruckType
string
Specifies the type of the truck Straight: A truck on a single frame with a permanently attached cargo area. Tractor: A towing vehicle that can pull one or more…
TransitStopAttributes_2
string
Extensible enum: noEntry noExit ... Attributes of a stop. noEntry: The transport cannot be entered at the stop. noExit: The transport cannot be exited at the s…
NetworkRestrictedTruck
object
A truck transport mode with additional restrictions on the road networks that can be used for routing. The road networks are defined via the permittedNetworks…
1 property
1 required
TollFare
object
Contains information about a single toll fare needed for this section of the route.
9 properties
3 required
AreasPost
array
List of user-defined areas that routes should avoid/exclude going through. Notes: Maximum count of avoided and excluded polygons and corridors is 20. Maximum t…
AccessAttributes
string
Extensible enum: open noThrough tollRoad ... AccessAttributes is applied to a span of a route section and describes access flags of a street. open: A part of t…
Passthrough
object
Describes a location and time the section is passing through.
2 properties
1 required
RouteResponseNotice
object
A notice contains important notifications.
4 properties
1 required
PedestrianSummary
object
Total value of key attributes for a route section.
3 properties
2 required
SignpostLabel
Label on a signpost.
CalculateRoutesPostParameters
object
Parameters of the POST body for route calculation
5 properties
BaseSummary
object
Total value of key attributes for a route section.
3 properties
2 required
Driver
object
Driver parameters to be used for calculating routes with automatically added rest stops.
1 property
RouterRouteResponse
object
Returns a list of routes.
2 properties
1 required
ArriveAction_2
object
An arrival maneuver to be performed at or during a specific portion of a section.
9 properties
2 required
RoadInfoType
string
Type of the road (rural, urban, highway)
MaxSpeedOnSegment
string
A comma separated list of segments with restrictions on maximum baseSpeed. Each entry has the following structure: {segmentId}({direction})?;speed={maxBaseSpee…
BoundingBoxArea
object
A bounding box defined by two longitudes and two latitudes.
5 properties
5 required
RouterRoute
object
A basic route. Includes personal vehicles as car, truck, etc... For all modes, cf. transportMode.
5 properties
2 required
TruckTypeWithDefault
string
Specifies the type of the truck Straight: A truck on a single frame with a permanently attached cargo area. Tractor: A towing vehicle that can pull one or more…
WaitAction
object
A wait operation to be performed at or during a specific portion of a section.
3 properties
2 required
Rerouting
object
Rerouting parameters allow to request a new route calculation based on the route handle. All attributes are optional.
3 properties
MatchTraceVia
object
Via waypoint in the middle of route
2 properties
1 required
EMobilityServiceProvider
object
Information about E-Mobility Service Provider
2 properties
EV
object
EV properties to be used for calculating consumption. There are two consumption models (empirical, physical). Set the consumptionModel parameter to choose whic…
7 properties
Areas
string
A pipe separated list of user-defined areas that routes should avoid/exclude going through. Notes: Maximum count of avoided and excluded polygons and corridors…
EVPost
object
2 properties
RouteResponseNoticeDetail
Details attached to notices in route response.
TransitNoticeDetail
Details attached to notices in vehicle section.
WalkAttributes_2
string
Extensible enum: stairs park indoor open noThrough tollRoad ... WalkAttributes are applied to a span of a route section and describe walk-related attribute fla…
FarePass
object
Specifies whether this Fare is a multi-travel pass, and its characteristics
5 properties
Speed
number
Speed in meters per second
Routing403ErrorResponseSchema
object
DockingStationPlace_2
object
A place represents a docking station for rented vehicles.
7 properties
2 required
ChargingSetupAction
object
An action to prepare for vehicle charging. Represents the time spent setting up for charging (e.g., payment processing), independent of the time required to ac…
3 properties
2 required
Fuel
object
Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes. Fuel parameters to be used for calculating consumption a…
5 properties
1 required
TurnAngle
number
The angle of the turn expressed in degrees. It is available only for turn-by-turn actions. A positive number indicates a clockwise angle.
RouteLabel
object
Road name or route number distinguishing a route from other alternatives.
2 properties
TrafficIncident
object
An incident describes a temporary event on the road network. It typically refers to a real world incident (accident, road construction, weather condition, etc.…
6 properties
Area
Area specified by boundingBoxes or polygons (as encoded polyline or as list of geopts ) or corridor area. Notes: Maximum count of avoided and excluded polygons…
EncodedPolygonAreaWithExceptions
object
A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string. Can be expanded to include excepted areas that are ex…
3 properties
2 required
TollSummary
object
The summary of the tolls grouped by criteria (total, per system, per country).
3 properties
GetRoutesByHandlePostParameters
object
Parameters of the POST body for get route by handle
4 properties
FarePassValidityPeriod
object
Specifies a temporal validity period for a pass
2 properties
1 required
TollSystemSummary
object
2 properties
AxleGroupWeight
object
Contains the maximum allowed weight for an axle-group.
2 properties
Place_2
object
A place represents a generic location relevant for the route.
7 properties
2 required
TollCountrySummary
object
2 properties
ChargingStationPlace_2
object
A charging station
12 properties
2 required
Taxi
object
Taxi-specific parameters
1 property
EVConsumption
EV properties to be used for calculating consumption. There are two consumption models (empirical, physical). Set the consumptionModel parameter to choose whic…
FunctionalClass
integer
Functional class defines a hierarchical network used to determine a logical and efficient route. The following classifications are used: 1: Roads that allow fo…
TrafficIncidentCriticality
string
Describes the impact an incident has on the route. critical - The part of the route the incident affects is not usable. major - Major impact on duration, e.g.…
BoundingBoxAreaWithExceptions
object
A bounding box defined by two longitudes and two latitudes. Can be expanded to include excepted areas that are excluded from the current bounding box area.
6 properties
5 required
RouterMode
string
Mode of transport to be used for route calculation.
ConsumptionModel
string
Extensible enum: empirical physical ... Specifies which of the EV consumption models is being used. See the ev parameter for details on the models. empirical p…
LocalizedRouteNumber
object
Represents a route number in specific language with optional cardinal direction and route level.
4 properties
1 required
MaxSpeed
Speed in meters per second, or "unlimited" indicating that the speed is unlimited, e.g., on a German autobahn
TollCost
object
Information for a single toll payment.
6 properties
3 required
TrafficIncidentType
string
Extensible enum: accident congestion construction disabledVehicle massTransit plannedEvent roadHazard roadClosure weather laneRestriction other ... An open lis…
CorridorAreaWithExceptions
object
A polyline with a specified radius in meters that defines an area. Can be expanded to include excepted areas that are excluded from the current corridor area.
4 properties
3 required
ParkingLotPlace_2
object
A parking lot
10 properties
2 required
HazardousGoodsRestriction
string
Extensible enum: explosive gas flammable combustible organic poison radioactive corrosive poisonousInhalation harmfulToWater other ... Hazardous goods restrict…
ExitAction_2
object
An action to leave a highway or roundabout. exit: exit maneuver, such as "Take the left exit to" roundaboutExit: roundabout exit maneuver, such as "Take the th…
15 properties
2 required
HovAttributes
object
hovAttributes is applied to a span of a route section and indicates the presence of usable HOV lanes on the span. Additional HOV-attributes may be supported in…
1 property
StationPlace_2
object
A station
11 properties
2 required
LicensePlateRestrictionType
string
Extensible enum: lastCharacter ... Specifies the components of the vehicle license plate considered for the restriction.
MaxSpeedOnSegmentPost
array
Segments with restrictions on maximum baseSpeed. For the general description of the functionality please refer to the maxSpeedOnSegment parameter of the query…
ForbiddenHazardousGoods
RoutingZone
object
Information about a routing zone.
4 properties
StreetAttributes
string
Extensible enum: rightDrivingSide dirtRoad tunnel bridge ramp motorway roundabout underConstruction dividedRoad privateRoad controlledAccessHighway builtUpArea…
Waypoint
string
A location defining an origin, destination or via point for a route or an isoline. Format: Place[WaypointOptions] Place: {lat},{lng}[PlaceOptions] PlaceOptions…
Location_2
object
Location on the Earth
3 properties
2 required
TimeWithAny
string
Specifies the time either as "RFC 3339, section 5.6 as defined by either date-time or date-only 'T' partial-time (ie no time-offset)", or the special value any…
TransitSection_2
object
A section of the route. It contains departure, arrival, and route information.
24 properties
4 required
DepartAction_2
object
A departure maneuver to be performed at or during a specific portion of a section.
9 properties
2 required
EncodedPolygonArea
object
A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string. The polygon is automatically closed, so repeating the…
2 properties
2 required
SignpostInfo
object
Signpost information attached to an offset action.
1 property
1 required
EncodedCorridorAreaWithExceptions
object
A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string and with a specified radius that defines an area. Can…
4 properties
3 required
LicensePlateRestriction
object
Contains details of the violated license plate restriction.
2 properties
StateCode
string
The second part of an ISO-3166-2 code (e.g., TX from USA-TX) consists of up to three alphanumeric characters. It is used to identify the principal subdivisions…
VehicleTransport
object
Information about a transport
3 properties
1 required
RoadInfo
object
Road information attached to an offset action
4 properties
PedestrianDeparture_2
object
Departure of pedestrian
2 properties
1 required
CustomizationHRN
string
HERE Resource Name identifier for customization. This HRN must follow a convention below: hrn:here: :: :custom: : .
TransitTransport_2
object
Transit transport information.
8 properties
1 required
LocalizedString
object
String with optional language code.
2 properties
1 required
TimeDomain
string
Specifies date and time period during which the restriction applies. Value is a string in the Time Domain format. Time Domain is part of the GDF (Geographic Da…
ConsumptionType
string
Extensible enum: electric diesel petrol lpg cng lng ethanol propane hydrogen ... Vehicle consumption type. The energy or fuel consumption type (electric, diese…
ExitInfo
object
Exit information attached to an offset action
1 property
Consumption
number
Energy or fuel consumption. For EV energy consumption is in kilowatt hours (kWh). For fuel-based vehicles fuel consumption is in Liters (L) for diesel, petrol…
SignpostLabelRouteNumber
object
Route number on a signpost label. The routeType property of the LocalizedRouteNumber is always null at the moment for SignpostLabel, because the data is curren…
1 property
PedestrianPostAction_2
SimpleTurnAction_2
object
Turn maneuver, such as "Make a sharp right turn at"
13 properties
2 required
AvoidPost
object
Avoid routes that violate certain features of road network or that go through user-specified geographical bounding boxes. For the general description of the fu…
2 properties
Routing429ErrorResponseSchema
object
EVRouteHandle
object
EV properties to be used for calculating consumption. There are two consumption models (empirical, physical). Set the consumptionModel parameter to choose whic…
1 property
Vehicle
object
Vehicle-specific parameters
31 properties
ViolatedTransportMode
object
Contains details about the violated transport mode on this road, such as trucks being generally forbidden.
3 properties
1 required
Agency
object
Contains information about a particular agency.
3 properties
2 required
EVEmpiricalModel
object
Specifies parameters required for calculation of energy consumption for electric vehicles using the Empirical model.
21 properties
1 required
EncodedCorridorArea
object
A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string and with a specified radius that defines an area.
3 properties
3 required
VehiclePlace
Place used in vehicle routing.
VehicleTravelSummary
object
Total value of key attributes for a route section.
7 properties
2 required
RouterSection
One of the possible sections that can be part of the Router route. TransitSection is only used for ferries and car shuttles.
ViolatedChargingStationOpeningHours
object
A charging stop was planned at the destination of this section, but the postActions would not be completed within the opening hours.
4 properties
1 required
TransitAction
Action attached to a transit section.
PaymentMethod
string
Extensible enum: cash bankCard creditCard passSubscription transponder videoToll cashExact travelCard ... Recognized methods of payment.
Allow
object
Explicitly allow features that require users to opt in.
2 properties
VehicleNoticeDetail
Details attached to notices in vehicle section.
AreaPost
Defines an explicit area to avoid/exclude when calculating the routes. Area specified by boundingBoxes or polygons (as encoded polyline or as list of geopoints…
ViolatedZoneReference
object
Provides details about the zone associated with violatedZoneRestriction and the violated restriction conditions that were evaluated against parameter values se…
8 properties
1 required
SegmentRef
string
A reference to the HMC topology segment used in this span. The standard representation of a segment reference has the following structure: {catalogHrn}:{catalo…
DynamicSpeedInfo
object
Describes dynamic speed information, such as traffic speed, estimated speed without traffic, and turn time.
3 properties
3 required
TransitDeparturePlace
Departure/arrival location
MatchTrace
object
Trace file with points and path match parameters
2 properties
1 required
ChargingAction
object
An action to charge the vehicle.
6 properties
2 required
Traffic
object
Traffic specific parameters.
2 properties
OffsetAction_2
object
An action to be performed at or during a specific portion of a section.
9 properties
2 required
ReroutingMode
string
Defines what kind of additional route calculation should be done. none - Cuts off route before the current position. Updates dynamic attributes of the route af…
VehicleDeparture
object
Describe a departure or arrival location and time.
3 properties
1 required
PolygonAreaWithExceptions
object
A polygon defined as a list of coordinates. Self-intersecting polygons are not supported. Can be expanded to include excepted areas that are excluded from the…
3 properties
2 required
TurnAction
object
An action in which a direction change is made.
13 properties
2 required
CorridorArea
object
A polyline with a specified radius in meters that defines an area.
3 properties
3 required
HazardousGoodsRestrictionArray
array
Provides a list of all hazardous goods that are restricted during the trip.
PermittedNetworksPost
array
Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes. A list of road networks permitted to be used. These road…
ConsumptionSpeedTable
string
Function curve specifying consumption rate at a given speed. The format of the string is a comma-separated list of numbers, as follows: , , , ,..., , where spe…
FuelType
string
Extensible enum: diesel petrol lpg cng lng ethanol propane hydrogen ... Vehicle fuel type. It is mandatory for calculation of consumption and CO2 emission.
CountryCode
string
ISO-3166-1 alpha-3 code
Avoid
object
7 properties
AccessPointPlace_2
object
Access point to a venue/station
8 properties
2 required
TransitDeparture_2
object
Transit departure
3 properties
1 required
VehiclePostAction
Action attached to a vehicle section that must be done after arrival.
RoutingMode
string
Specifies which optimization is applied during the calculation. fast: Route calculation from start to destination optimized by travel time. In many cases, the…
ContinueAction_2
object
A continue operation to be performed at or during a specific portion of a section.
10 properties
2 required
Notice_2
object
A notice contains important notifications.
4 properties
1 required
Return
string
Defines which attributes are included in the response as part of data representation of a Route or Section. polyline - Polyline for the route in [Flexible Poly…
VehicleMode
string
Extensible enum: car truck bicycle scooter taxi bus privateBus networkRestrictedTruck ... Vehicle mode of transport. Since the supported vehicle modes may be e…
TollCollectionLocation
object
Refers to the physical location where the toll is collected. This can include various structures such as toll booths, transponder readers, or number-plate came…
2 properties
1 required
VehicleNotice
object
A notice contains important notifications.
4 properties
1 required
Truck
object
Vehicle-specific parameters
31 properties
SignpostLabelText
object
Text on a signpost label.
1 property
PedestrianNotice_2
object
A notice contains important notifications.
4 properties
1 required
NetworkRestrictedTruckPost
object
Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes. Parameters specific to the networkRestrictedTruck transp…
1 property
Exclude
object
Options to exclude strictly during the route calculation.
3 properties
TruckAxleCountRange
object
Constrains the restriction to trucks with the number of axles within the specified range.
2 properties
MatchTracePoint
object
GPS probe point with parameters relevant to path or route matching
2 properties
2 required
VehicleAction
Action attached to a vehicle section.
Fare_2
object
"Fare type contains information about a single fare or ticket needed for this section of the route." NOTE: Fares information support will be available soon.
9 properties
3 required
BaseNoticeDetail
object
3 properties
1 required
ChargePointOperator
object
Information about the charging station charge-point-operator
2 properties
ExcludePost
object
User-specified properties that need to be strictly excluded during route calculation. For the general description of the functionality please refer to the excl…
1 property
PedestrianSection_2
object
Represent a section of a route
17 properties
5 required
VehicleSpan
object
Span attached to a Section that describes the vehicle content.
32 properties
TollSystem
object
Information about a toll system collecting payments on the route.
2 properties
PedestrianTransport_2
object
Information about a transport
2 properties
1 required
ViaNoticeDetail
object
Details about via waypoint.
4 properties
1 required
TrailerCountRange
object
Constrains the restriction to vehicles with the number of trailers within the specified range.
2 properties
Coordinate
object
2 properties
2 required
Tolls
object
Vehicle-independent options that may affect route toll calculation as well as options affecting the output of the tolls, such as summaries. Since this paramete…
5 properties
PermittedNetworks
object
Disclaimer: This object is currently in beta release, and is therefore subject to breaking changes. This span contains information about the networkRestrictedT…
1 property
TransitNotice_2
object
A notice contains important notifications.
4 properties
1 required
Scooter
object
Scooter-specific parameters
1 property
HazardousGoodsRestrictionAny
string
Indicates that all hazardous goods are subject to restrictions during the trip.
VehicleSummary
object
Total value of key attributes for a route section.
7 properties
2 required
ViolatedTruckRoadType
object
Contains details about the violated truck road type on this road.
4 properties
1 required
VehicleRestriction
object
Provides details about the violated restriction and the violated restriction conditions that were evaluated against parameter values set in the routing request…
27 properties
1 required
RefReplacements
object
Dictionary of placeholders to replacement strings for the compact representation of map entity references.
TransitSpan
object
Contains information attached to a contiguous part of a Section. The information may be attached along different dimensions of a section which are geometry (sp…
9 properties
KeepAction_2
object
Keep maneuver, such as "Take the middle fork onto"
13 properties
2 required
RoutingErrorResponse
object
Response in case of error
6 properties
6 required
WebLinkWithDeviceType_2
object
The URL address to an external resource.
5 properties
2 required
WeightPerAxleGroup
string
Specifies the weights of different axle groups, such as single and tandem axles. This allows specification of axle weights in a more fine-grained way than weig…
VehicleType
string
Specifies the type of the vehicle StraightTruck: A truck on a single frame with a permanently attached cargo area. Note: default value when truck routing mode…
VehicleRestrictionMaxWeight
object
Contains the maximum permitted weight, specified in kilograms, along with the specific type of the maximum permitted weight restriction.
2 properties
VehicleSection
object
Represent a section of a route
24 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HERE 12
Other APIs HERE publishes across the network.
HERE Geocoding and Search API
HERE Autosuggest API
HERE Tour Planning API
HERE Public Transit API
HERE Destination Weather API
HERE Map Tile API
HERE Map Image API
HERE Tracking API
HERE Positioning API
HERE Parking API
HERE Platform Data API
HERE HD Live Map
#Routing
Where this information came from
This is an independent, third-party profile of HERE Routing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.