Geocoder API Developer's Guide

Reverse Geocode Resource

This section contains a list of all Reverse Geocode request parameters.
Table 1. Request Parameters
Parameter Element

Key-value pairs that provide additional input to requests. See Additional Data Parameter for a full list. Key and value are separated using a ,. Multiple key-value pairs are separated using a ;:




Comma separated list of which elements are present in the response data.

Enumeration [country, state, county, city, district, subdistrict, street, houseNumber, postalCode, addressLines, additionalData]

Abbreviated forms: [ctr, sta, cty, cit, dis, sdi, str, hnr, pst, aln, add]

On by default: All except addressLines.

Note: The value names are case-sensitive.



A 20 byte Base64 URL-safe encoded string used for the authentication of the client application.

You must include an app_id and app_code with every request.  To get an app_id assigned to you, please see Acquiring Credentials.



A 20 byte Base64 URL-safe encoded string used for the authentication of the client application.

You must include an app_id and app_code with every request.  To get an app_id assigned to you, please see Acquiring Credentials.



The gen parameter enables or disables backward incompatible behavior in the API. Please see details and the generation history in chapter Different Generations of the Same API. The latest generation is always recommended. This is currently gen=9.



If set to 1, the first character of each JSON response attribute name is set to lower case. Default value is 0.



Specifies the name of a user-defined function used to wrap the JSON response.



The preferred language of address elements in the result. Language code must be provided according to RFC 4647 standard. Note that the plural form of the parameter (languages) is supported as well. But only the last specified language in the list is used. All preceding language preferences are ignored at this time.



Target match level of the search result. One of [country, state, county, city, district, postalCode]. Only valid in combination with gen=2 or higher.

Comma separated list of which elements are present in the response data.

Enumeration [address, mapReference, mapView, addressDetails, streetDetails, additionalData, adminIds, linkInfo, adminInfo, timeZone, addressNamesBilingual, related.nearByAddress]

Abbreviated forms: [ar, mr, mv, dt, sd, ad, ai, li, in, tz, nb, rn]

The adminIds switch is available with forward geocoding only.

For reverse geocoding results adminIds are always present unless turned off via locationattributes=none. locationattributes=-adminIds has no effect on reverse geocoding results.

The related.nearByAddress switch is available with the trackPosition mode of reverse geocoding only.

On by default for reverse geocoding: address, mapView, additionalData, mapReference, adminIds.

For forward geocoding: address, mapView, additionalData.

With mapReference link PVID, side of street, and admin area PVIDs are present in the response data. With adminIds only admin area PVIDs are present.

Note: The value names are case-sensitive.



The number of items in the response structure can be limited. By specifying maxresults, the number of results per response are limited. When more results than the defined maximum are available, then these are returned on additional, separate pages. Each response contains a handle to the next page. For example, maxresults=5 returns a maximum of 5 results per page. If there were 8 results in total, the first page of five results indicates that there is a second page with more results.

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2


Ignore the specified radius until minResults results are found. Default is 0. Supported for Reverse Geocode mode=retrieveAreas and mode=retrieveAddresses.

One of five values:
  • retrieveAddresses - Search for the closest street address or addresses
  • retrieveAreas - Retrieve the administrative area information for the position provided in the request
  • retrieveLandmarks - Search for landmarks like parks and lakes in the proximity provided in the request
  • retrieveAll - Search for streets, administrative areas and landmarks. This mode aggregates the results of the three different modes in one call
  • trackPosition - Retrieve street and address information based on a position and bearing


A key which identifies the page to be returned when the response is separated into multiple pages. Only relevant, if maxresults has been specified in a previous request and the response to the request includes the information that there is another page, for example:

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2

xs:string (3 bytes, ISO 3166-1-alpha-3)

Specify the political view. Available territories will be seen through the point of view of this country. If this parameter is not specified the neutral international view is made available, where territories may have unresolved claims.

For a complete list of supported views please see the appendix Political View.

For any political view that is unsupported the Geocoder falls back to the default view. For example, politicalview=USA or politicalview=FRA does not impact a response in any way.



A position with latitude, longitude, and bearing. Bearing expresses the direction in which an asset is heading in degrees starting at true north and continuing clockwise around the compass. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees.


GeoProximityType, see also GeoProximityType


A type of SpatialFilter. A spatial filter limits the search for any other attributes on the request. Proximity specifies a circle to search using a latitude, a longitude, and a radius in meters.


Comma separated list of which elements are present in the response data.

Enumeration [performedSearch, matchQuality, matchType, matchCode, parsedRequest]

Abbreviated forms: [ps, mq, mt, mc, pr]

On by default: matchQuality, matchType

Note: The value names are case-sensitive.



Sort results by distance (default), population count, or size (approximate area size). One of [distance, population, size].

Currently only supported for Reverse Geocode mode=retrieveAreas. If population count is not available for an entity the service falls back to sort by area size.



  • True - if the value is available in the first language specified in the language parameter the attribute value is set directly in Address, Place, Location, and Category elements. Values in alternative languages are returned in the AlternativeValues element.
  • False - the best available attribute value based on the language priorities given in language parameter is returned directly in Address, Place, Location, and Category elements. No alternatives are returned.


An URL-encoded Base64 string of typically (but not guaranteed to be) 24 bytes. The token is generated based on the user's app_id and received after the registration process of the application.

Parameter token is deprecated, use app_code instead.

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