Fleet Telematics Custom Locations Developer's Guide

Bounding Box Search

Search for custom geometries within a specified rectangular geographic area.

The number of geometries in the response should not exceed 1000, and the search space must not comprise more than 150 tiles. Exceeding one of the limits results in an error response. If an application needs more results returned then please contact technical customer support to work on a solution to reduce this.

Resource URI

GET /search/bbox.json

Resource Parameters

Parameters Required? Description
apikey Yes


A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://developer.here.com/projects/. API keys never expire but you can invalidate your API keys at any time. You cannot have more than two API keys for one app at the same time.

You must include an API key with every request. For further details, see Acquiring Credentials.

layer_id Yes Layer ID identifying the layers to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be lookup up in the service via /serviceconfiguration.json
bbox Yes

The bounding box upper, left, lower and right coordinates in WGS84 degrees. All geometries overlapping this rectangle will be returned.

The format is latitude,longitude;latitude,longitude.

Example: bbox=37.8,-122.1;37.2,-122.0

geom No 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.
filter No

An JavaScript expression being evaluated for each geometry matching search query.

Columns value for the geometry are available as defined variables.

When specified, only geometries where expression evaluates to true will be returned.

Example: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')

Parameter value must be url encoded when using special characters.

This filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):

  • COL_NAME.indexOf("my_substring") >= 0
  • COL_NAME.startsWith("my_prefix")
  • COL_NAME == "str"
  • COL_NAME === "str"
  • COL_NAME != "str"
  • COL_NAME !== "str"
  • COL_NAME.indexOf("str") >= 0
  • COL_NAME.startsWith("str")
  • COL_NAME.like("%str%")

To avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.

callback No Specifies the function used to wrap the JSON response.

Response Example

To see an example of a bounding box search response, see Custom Locations in a Rectangle.