Custom Location Extension API Developer's Guide

Attribute Search and Layer Download

Search for custom geometries by attribute filter, or download complete layer.

Resource URI

GET /search/all.json /search/all.txt

Resource Parameters

Parameters Required? Description
app_id Yes A URL-safe encoded string obtained during the application registration. See Acquiring Credentials for information on getting credentials.
app_code Yes A URL-safe encoded string obtained during the application registration. See Acquiring Credentials for information on getting credentials.
layer_id Yes Layer ID identifying the layers to be searched. Can also be a comma separated list of layers. 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
geom No full or none. Specifies the geometry representation in the result. Default = full. 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 polygones 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.

start_geoemtry_id No To paginate huge responses, this parameter specifies the lowest geometry id to be returned. If geometry ids are not known, then retrieve the first page using zero, and to retrieve subsequent pages then request highest geometry of current page + 1 (it doesn't matter whether this geometry id actually exists or not). Use this parameter together with no_of_records.
no_of_records No

The maximum number of geometries in the response. If more geometries satisfy the search/filter criteria, they will be suppressed.

It is undefined, which of the matching geometries are returned, unless this parameter is used together with start_geometry_id, which sorts the results set by geometry id.

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

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.