Geocoder API Developer's Guide

Customizing the Response with Attribute Switches

Responses always contain a default set of elements. You can increase or reduce the amount of information in the response using attribute switch parameters to specify which elements are returned.

For example, to add matchCode and parsedRequest add the following to the request:

&responseattributes=matchCode,parsedRequest

or use abbreviated forms

&responseattributes=mc,pr

The following example removes mapView and returns only address and mapReference.

&locationattributes=-mapView

To add additionalData to the previous example, returning address, mapReference and additionalData use:

&locationattributes=-mapView,additionalData

If all attributes except mapView are required, use the all value and remove unnecessary attributes. The following example returns the whole attribute set except mapView.

&locationattributes=all,-mapView
If you only want to specify a small set of attributes, use the none value and add required attributes. The following example returns only address.
&locationattributes=none,address
Table 1. Attribute switches and values
Attribute switch Values
addressattributes

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.

locationattributes

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.

responseattributes

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.

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.