Migrate Autocomplete Requests

WARNING

The /autocomplete endpoint is in BETA state.

This section covers the actions that must be taken to migrate a Geocoder Autocompletion API request to a GS7 Autocomplete request.

For more details about the types or specification of parameters, see the Developer Guide.

Base URL, Version, Resource

Use the GS7 /autocomplete endpoint to migrate the freeform or qualified search text queries to GS7.

Parameter Geocoder Autocompletion API GS7
Base URL https://geocoder.api.here.com https://autocomplete.search.hereapi.com
Version /6.2 /v1
Resource / Endpoint /suggest /autocomplete
Format specifier .json -

Both Geocoder Autocompletion API and HERE Geocoding and Search v7 support only JSON output format. In HERE Geocoding and Search v7 the format specifier must be omitted.

Query parameters

Geocoder Autocompletion API GS7 comment
query q
maxresults limit Similar to HERE Geocoder API Autocomplete, the GS7 /autocomplete has the default limit set to 5. The maximum value for the limit parameter supported by /autocomplete is 20.
country in=countryCode
prox at GS7 at parameter does not support radius.
language lang Similar to HERE Geocoder API Autocomplete, the GS7 /autocomplete lang parameter allows the customer application to set the preferred response language.
resultType types The values of the result type filter supported by the /autocomplete endpoint: area, city, postalCode. Note that result type filter postalCode covers only regular postal codes such as in Germany or ZIP codes in the USA. "High Precision" postal codes, such as postal codes in the UK or USA postal codes with ZIP+4 extensions are not included.

Response attributes

Geocoder Autocompletion API GS7 comment
suggestions items
suggestions[].label items[].title
suggestions[].countryCode items[].address.countryCode
suggestions[].locationId items[].id The location id of HERE Geocoder API and id of GS7 have different formats and are not compatible.
suggestions[].address.country items[].address.countryName items[].address.countryCode GS7 returns country name in the countryName field and country code in countryCode field.
suggestions[].address.state items[].address.state, items[].address.stateCode GS7 returns state name in the state field and state code, where commonly used, in stateCode field.
suggestions[].address.county items[].address.county, items[].address.countyCode GS7 returns county name in the county field and county code, where commonly used, in countyCode field.
suggestions[].address.city items[].address.city
suggestions[].address.district items[].address.district
suggestions[].address.street items[].address.street, items[].address.streets For house number or street results, GS7 returns the single street name in the field street. For intersection results, GS7 returns a list of street names in the array streets (plural).
suggestions[].address.postalCode items[].address.postalCode
suggestions[].address.houseNumber items[].address.houseNumber
suggestions[].distance items[].distance
suggestions[].matchLevel items[].resultType extended with one of: items[].addressBlockType, items[].localityType, items[].administrativeAreaType For details, see result types.

Currently not supported

The following query parameters are currently not supported in Geocoder Autocompletion API service:

Geocoder Autocompletion API comment
app_id GS7 authentication does not support the app_id/app_code method. For the available authentication options, see the Identity & Access Management Developer Guide.
app_code GS7 authentication does not support the app_id/app_code method. For the available authentication options, see the Identity & Access Management Developer Guide.
mapview GS7 /geocode does not support spatial filters. Use the at parameter for spatial reference.
beginHighlight GS7 /autocomplete has default way to return highlighting info, different from HERE Geocoder API Autocomplete. For more details, see Response Attributes.
endHighlight GS7 /autocomplete has default way to return highlighting info, different from HERE Geocoder API Autocomplete. For more details, see Response Attributes.

The following response attributes are currently not returned in Geocoder Autocompletion API service:

Geocoder Autocompletion API comment
suggestions[].language
suggestions[].address.unit GS7 /autocomplete does not support secondary unit designator detection.

results matching ""

    No results matching ""