GuidesAPI Reference
Guides
  1. HERE Geocoding and Search API v7 Developer Guide
  2. Configure request parameters

Response enrichment

HERE Geocoding and Search allows developers to get richer response items attributes through the addition of the request query parameter show.

The currently supported values for show are listed in the table:

show valueendpointsmaturity privilegeDescription
countryInfo/geocode, /revgeocode, /multi-revgeocode, /lookupGAAdds to each result item a block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code.
ev/browse, /discover, /lookupGAAdds available electric vehicle charging station connector details to place response items of category ID 700-7600-0322, 700-7600-0323, 700-7600-0324. See the dedicated page EV Charge Points if necessary.
eMobilityServiceProviders/browse, /discover, /lookupGAAdds available electric vehicle charging station service provider details to place response items of category ID 700-7600-0322, 700-7600-0323, 700-7600-0324. See the dedicated page EV Charge Points if necessary.
parsing/geocodeGAThe /geocode endpoint can provide information about how it parsed a request. Applications can use the information to decide whether a request requires further processing or not. Applications can also use the information for address cleansing, for example, to increase the Geocoder success rate and confidence level for future geocoding requests.
phonemes/autosuggest, /browse, /discover, /lookupGAAdds available phonetic details for address and place names to the response items.
postalCodeDetails/geocode, /revgeocode, /multi-revgeocode, /lookupGAFor each result item of type 'postalCodePoint' renders block with additional information about this postal code, such as postal code type: ZIP or ZIP+4; ZIP classification code: PO BOX, Unique or military; record type code for ZIP+4 codes. This feature is currently available only in the countries which are using ZIP codes. /revgeocode endpoint supports this value, but since currently it does not support 'postalCodePoint' results in the USA and other countries which are using ZIP codes, it does not have any impact.
secondaryUnitInfo/geocodeGAFor each matched unit designator, returns an additional block containing the normalized unit type and unit value. Currently supported countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, IDN, IND, NZL, TUR, TWN, USA.
streetInfoallGAAdds to each response item an additional block with the street name decomposed into its parts like the base name, the street type, etc.
tzall except /autocompleteGAAdds to result items IANA TZ time zone information.
tripadvisor/browse, /discover, /lookupBETA, RESTRICTEDAdds available Tripadvisor(TM) rich attributes (image, ratings, editorials) to place response items. Please check below below warning notes.
tripadvisorImageVariants/browse, /discover, /lookupBETA, RESTRICTEDAdds available Tripadvisor(TM) image variants to place response items. An image variants are details of the same image in various sizes (thumbnail, small, large, ...). Please check below warning notes.
fuel/autosuggest, /browse, /discover, /lookupBETA, RESTRICTEDAdds available fuel station related information (fuel types, additives, pay at the pump information, ...) to place response items.
truck/autosuggest, /browse, /discover, /lookupBETA, RESTRICTEDAdds available truckers amenities (truckWash, highCanopy, idleReduction, ...) to place response items.
fuelPrices/browse, /discover, /lookupBETA, RESTRICTEDAdds available fuel station related pricing information to place response items. This option can only be used in combination with fuel or truck.
addressUsage/geocode, /revgeocode, /multi-revgeocode,/lookupALPHA, RESTRICTEDAn attribute is provided for a Point Address result to identify if the address is a residential address or a commercial (a business) address. Note: This feature is released as Restricted ALPHA. Access is limited to authorized customers only.
hasRelatedMPA/autocompleteALPHA, RESTRICTEDA flag is provided for a Point Address result in the /autocomplete endpoint to indicate that sub-premises (referred to as Micro Point Addresses in HERE terminology) are associated with the house number. You can use this flag to initiate a follow-up call to the /lookup endpoint using the corresponding id and the showRelated=MPA parameter to retrieve the Micro Point Address (MPA) list and details. Note: This feature is released as Restricted ALPHA. Access to MPA content is limited to authorized customers only.

Example of a /lookup response with show=streetInfo,tz,phonemes:

{
  "title": "Vanille Noire",
  "id": "here:pds:place:250jx7ps-8f300d0f8ec60e31fb76a3d22f00f18f",
  (...)
  "timeZone": { "name": "Europe/Paris", "utcOffset": "+02:00" },
  "phonemes": {
    "placeName": [{ "value": "va|\"nij \"nwaR", "language": "fr", "preferred": true }],
    "countryName": [{ "value": "\"frAns", "language": "en-GB", "preferred": true }],
    "state": [{ "value": "pr@|\"vQns \"{lps \"ket \"d{|zVr", "language": "en-GB", "preferred": true }],
    "county": [{ "value": "\"buS %dy \"Ron", "language": "fr", "preferred": true }],
    "city": [{ "value": "mA|\"seI", "language": "en-GB", "preferred": true }],
    "street": [{ "value": "\"Ry kEs|\"Ri", "language": "fr", "preferred": true }]
  },
  "streetInfo": [
    {
      "baseName": "Caisserie",
      "streetType": "Rue",
      "streetTypePrecedes": true,
      "streetTypeAttached": false,
      "language": "fr"
    }
  ]
}

Additionally to show parameter, HERE Geocoding and Search supports several customizable parameters, allowing users to further enhance the response.

The currently supported parameters and values are listed in the table:

parameter namesupported valuesendpointsmaturity privilegeDescription
showRelatedMPA/geocode, /lookupGA, RESTRICTEDEnrich a response item with related items.
parentPA/geocode, /revgeocode, /multi-revgeocode, /lookupGA, RESTRICTEDEnrich a response item with related items.
intersections/geocode,/revgeocode, /multi-revgeocodeGA
nearbyAddress/revgeocode, /multi-revgeocodeGA
showTranslationsstate, county, city, district/geocodeGAEnhance the response with translations and alternative names of the provided fields in all available languages.
showMapReferencesadminIds, pointAddress, segments/autosuggest, /geocode, /revgeocode, /multi-revgeocode, /lookupGAEnrich a response item with map references.
cmVersion, links/geocode, /revgeocode, /multi-revgeocode, /lookupGAEnrich a response item with map references.
microPointAddress/geocode, /revgeocode, /multi-revgeocode, /lookupGA, RESTRICTEDEnrich a response item with map references.
showNavAttributesfunctionalClass, access, physical, speedLimits/geocode, /revgeocode, /multi-revgeocode, /lookupGAEnrich a response item with navigation attributes.
📘

Note

Each application entitled to expose Tripadvisor(TM) rich attributes is expected to be adapted so that it complies with the Tripadvisor Branding Guidelines specified at https://tripadvisor.mediaroom.com/logo-guidelines

In case of a mobile phone application, it must additionally render a "Find out more" hyperlink using the HERE Geocoding and Search editorials block href response field to the TripAdvisor site.

HERE WeGo example:

Tripadvisor in HERE WeGo

Updated last month