Map Broker Services

Routing

Calculate a route between an origin and a destination for a generic vehicle or a pedestrian, based on the HERE Routing API v8.

To see the full list of parameters or their details, visit the HERE Routing API documentation.

Endpoint

POSThttps://{host}:{port}/EgonMbk/api/routes

Headers & authentication

Required request headers and their expected values.

Field	Type	Description
`token`req	String	Authentication token sent in the `token` request header.

Request

Field	Type	Description
`transportMode`req	String	Mode of transport: `car`, `truck`, `pedestrian`, `bicycle`, `scooter`, `taxi`, `bus`, `privateBus`, or `networkRestrictedTruck`. Default value: `car`
`origin`req	String	Origin waypoint (WGS84). Format: `{lat},{lng}`.
`destination`req	String	Destination waypoint (WGS84). Format: `{lat},{lng}`.
`via`	String	Via waypoint(s). Multiple values are allowed and are traversed sequentially in the specified order.
`routingMode`	String	Route optimization: `fast` (default) or `short`. Default value: `fast`
`return`	String	Attributes to include in the response, including `polyline`, `actions`, `instructions`, `summary`, `travelSummary`, `turnByTurnActions`, `elevation`, `routeHandle`, `incidents`, and `tolls`.
`spans`	String	Map content attributes to include per span. Requires `return=polyline`.
`units`	String	Units of measurement: `metric` (default) or `imperial`. Default value: `metric`
`lang`	String	Preferred response language in BCP 47 format, for example `it,en-US`.

Response

Calculated routes and system status.

Field	Type	Description
`data`	Object	Calculated route data.
`routes`	Array	Route(s) calculated.
`id`	String	Unique route id.
`sections`	Array	Sections composing the route.
`id`	String	Section id.
`type`	String	Section type: `vehicle`, `pedestrian`, or `transit`.
`departure`	Object
`place`	Object
`type`	String	Type of place.
`location`	Object
`lat`	Number	Latitude (WGS84).
`lng`	Number	Longitude (WGS84).
`originalLocation`	Object
`lat`	Number	Latitude (WGS84).
`lng`	Number	Longitude (WGS84).
`arrival`	Object
`place`	Object
`type`	String	Type of place.
`location`	Object
`lat`	Number	Latitude (WGS84).
`lng`	Number	Longitude (WGS84).
`originalLocation`	Object
`lat`	Number	Latitude (WGS84).
`lng`	Number	Longitude (WGS84).
`summary`	Object
`duration`	Number	Duration in seconds.
`length`	Number	Length in meters.
`baseDuration`	Number	Duration ignoring traffic conditions.
`transport`	Object
`mode`	String	Mode of transport used.
`polyline`	String	Route geometry in Flexible Polyline encoding.
`actions`	Array	Actions required to complete the section.
`spans`	Array	Map content attributes for each span.
`routeLabels`	Array of String	Most important names and route numbers.
`routeHandle`	String	Encoded route handle for later route decoding.
`notices`	Array	Issues related to the route calculation.
`system`	Object	System error status.
`ret_code`	Number	Code: `0` means no blocking error; a value different from `0` is a blocking error code.
`des_ret_code`	String	Description of the return status.

On this page

Endpoint
Headers & authentication
Request
Response

Request Example

curl -X POST "https://{host}:{port}/EgonMbk/api/routes?transportMode=car&origin=44.9741733,7.7232365&destination=43.87644,11.11885&routingMode=fast&units=metric" \
  -H "token: YOUR_API_KEY"

Endpoint​

Headers & authentication​

Request​

Response​

Endpoint

Headers & authentication

Request

Response