Custom Route Extension API Developer's Guide

Calculate Route

Calculates a route using map modifications from custom overlay maps.

This resource is built on top of the Routing API, but currently, it only supports a subset of the features. Hence, before replacing a Routing API calculateroute.json / .xml call with this resource, make sure the features or parameters you require are supported. The parameters supported have the same meaning as those of the Routing API.

Custom Route Extension API redirects to HLP Router if no overlay is requested or the overla layer(s) don't exist or are not accessible to the app_id. So in this case, all HLP Router options can be used and the response is like specified for HLP Router.

Resource URI

GET /2/calculateroute.json
  &waypoint0=..., &waypoint1=..., ...

For more information, see Constructing a Request.

Resource Parameters

Parameter Description
overlays optional


Overlay map name. Case insensitive. Must contain the OVERLAY string.

mode mandatory


fastest;car;traffic:disabled or fastest;car;traffic:disabled.

waypoint0 ... waypointN mandatory


Comma separated waypoint latitude, longitude in WGS-84 degree. A route must consist of at least 2 waypoints (start and destination). The maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. None of the optional specifications geo!, stopOver!, passThrough!, StopOverDuration, altitude, transitRadius, custom label, heading, !StreetPosition, !LinkPosition are currently supported.

departure optional


Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. Default: Avoid all time dependent access restrictions. If no timezone is specified, then the local timezone at the route start link is used.

storage mandatory


Currently, only readonly is supported.

language optional


Language for the mneuver instructions in the response. Currently de-de, en-us and it-it are supported. If not specified, en-us is used.

avoidLinks optional


Comma separated list of link ids to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node.

Response Format

The response applies to CalculateRouteResponseType of the HERE Routing API with additions and modifications where overlay maps cause route changes.

For more information about CalculateRouteResponseType, see CalculateRouteResponseType.