GuidesAPI Reference
API Reference

Retrieve the POIs that are reachable within a certain time or distance from the main route

Retrieve the POIs that are reachable within a certain time or distance from the main route

Query Params
string
string
string

Comma separated list of layer IDs to be searched. Layer names are not case sensitive. Both custom layers and PDE map layers are supported. PDE layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. Layers must have a LINK_ID column. If a customer doesn't have a LINK_ID column, customers can create it using the Geocoder, Reverse Geocoder or RME. The maximum length of a layer name and the permitted characters can be looked up up in the service via v8/maps/serviceconfiguration

string

List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.

string
enum
Defaults to local

local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.

Allowed:
double

Either max_detour_distance or max_detour_time must be specified. Maximum travel distance in meter away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The distance to get back onto the route is not considered here.

double

Either max_detour_time or max_detour_distance Maximum travel time in seconds away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The time to get back onto the route is not considered here.

string
Defaults to updatable

Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.

string

Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.

string

Trailer type in a vehicle + trailer combination. Supported values: 0 - None (Default), 1 - Caravan, 2 - Trailer, 3 - RVTrailer, 4 - BoatTrailer. Applicable for toll cost calculation and recreational vehicle restrictions.

string

Number of vehicle axles excluding trailer axles. Applicable for toll cost calculation and country wide truck restrictions.

string

Number of trailer axles. Applicable for toll cost calculation and for country wide truck restrictions.

string

Type of hybrid vehicle. Supported values: 1 - fuel+electric, 0 - otherwise (Default). Applicable for toll cost calculation.

string

Emission type category of the vehicle. supported values: 1 - EURO I, 2 - EURO II, 3 - EURO III, 4 - EURO IV, 5 - EURO V, 6 - EURO VI, 7 - EURO EEV, 8 - Electric Vehicles, 9 - EURO II with PRC (deprecated), 10 - EURO III with PRC (deprecated), 11 - EURO VII.

  • Applicable for toll cost calculation and environmental zone restrictions.
  • When emissionType is not specified it defaults to 5.
string

CO2 emission class of the vehicle. Supported values: 1 - Emission class 1, 2 - Emission class 2, 3 - Emission class 3, 4 - Emission class 4, 5 - Emission class 5.

  • Applicable for toll cost calculation only. When co2EmissionClass is not specified then it defaults to 1.
  • Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
string

Actual height of the trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. For toll cost calculation only, not considered for route path creation (use height parameter).

string

Actual total weight of vehicle incl. payload, but not trailers' weight or payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. See also limitedWeight. Applicable for toll cost calculation only.

string

Used in routeMatch=0|2. Legal maximum weight limit of vehicle incl. payload and trailers. Also including their payload as a total. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. Applicable for truck restrictions only.

string

Vehicle is signposted to to carry disabled people. Accepted values are: 1 - vehicle equipped to carry disabled people, 0 - otherwise (default). Applicable for toll cost calculation only.

string

Actual number of passengers in vehicle. Applicable for toll cost calculation only.

string

Total number of tires from vehicle, including tires on the base vehicle and any attached trailers. Applicable for toll cost calculation only.

string

Vehicle use has commercial purpose. Accepted values are: 1 - vehicle registered for commercial use, 0 - no commercial use (Default: not specified). Applicable for toll cost calculation, environmental zone regulations and delivery-only zones.

string

Height of the vehicle above its first axle. Example: 350cm or 3.5m or 138in. Applicable for toll cost calculation only.

string

Defines the fuel powering the vehicle. Supported values: Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric, LPG - Liquefied Petroleum Gas, LNG - Liquefied Natural Gas). Applicable for environmental zone restrictions, toll cost calculation and consumption based routing for Electric vehicles.

string

Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported values: drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18 .

string

Actual total weight of trailers with their payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. See also parameter limitedWeight. Applicable for toll cost calculation only.

string

Number of trailers or semi-trailers. For toll cost and truck restrictions.

  • Supported values: 0 - no trailer (default), 1 - one or more trailers, 2 - two or more trailers, 3 - three or more trailers, 4 - one or more semi-trailers.
  • &trailersCount=4 is not supported for Waypoint Sequencing.
string

Actual height of the overall rigid/semi truck including trailers. Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. Applicable for truck restrictions and toll cost.

string

Actual total weight of vehicle incl. payload and trailers/caravan including their payload.

  • Accepted value units are t (tons), kg (kilograms) or lbs (pounds).
  • Example: 7.5t or 7500kg or 16500lbs.
  • Applicable for truck restrictions, speed profile selection, toll cost calculation and environmental zone restrictions. See also parameter vehicleWeight.
  • Note that country wide weight restrictions depend on the length, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.
string

Comma separated list from supported values: explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable.

  • Applicable for toll cost calculation and truck restrictions.
  • For toll cost only values explosive and other are supported.
  • For Waypoints Sequence values allhazardousGoods and explosiveFlammable are not supported.
string

Length of the vehicle (including potential trailers).

  • Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 1250cm or 12.5m or 492in.
  • Applicable for toll cost calculation and truck restrictions.
  • Note that country wide length restrictions depend on the limitedWeight, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.
string

Actual total weight per axle, incl. payload.

  • Accepted value units are t (tons), kg (kilograms) or lbs (pounds).
  • Example: 7.5t or 7500kg or 16500lbs.
  • For Waypoints Sequence only supported unit is kg, without explicitly specifying unit.
  • Applicable for toll cost calculation and truck restrictions.
string

Width of the vehicle and trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. Applicable for truck restrictions. Note that country wide width restrictions depend on the limitedWeight, length, number of axles and trailers as well, so it might be necessary to specify these parameters as well.

string

Defines the tunnel categories the truck must NOT use. Supported values: B, C, D or E.

  • A tunnels have no restrictions.
  • E tunnels have most restrictions.
  • Example: If &tunnelCategory=C is specified, then route will use A and B tunnels but not C, D or E.
string

Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.

string
string

Optional. Map within to look for the layer. Default: Look into the default map.

string

Specifies the function used to wrap the JSON response.

string

Define optional attributes to be returned for each link. Currently supported: cost.

string

Specifies in which intervals route isoline POIs are requested. Defined as from/to elapsed time on the route &searchInterval=fromSeconds,ToSeconds,FromSeconds,ToSeconds,...

string

The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated.

string
required

Either waypoints or route_id must be specified. 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. To define a loading/delay time at a waypoint, use stopOver[,timeInSeconds]!. Example: &waypoint1=stopOver,300!50.12,8.65. None of the optional specifications geo!, stopOver!, passThrough!, altitude, transitRadius, custom label, heading, !StreetPosition, !LinkPosition are currently supported.

string

A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html . Other authentication options are Bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.

Response

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8