Places (Search) API Developer's Guide

Autosuggest Entrypoint

The Autosuggest Entrypoint represents lists of suggested search terms, instants results and refined search links related to a given (partial) search term and location context. This entrypoint is used to help users save time, iterate on their searches, and get the results.

As-you-type-suggestion features of Autosuggest:
  • auto-suggest - exploratory search queries
  • disambiguation - providing end-user with contextual information to refine search
  • instant results of POI and addresses
  • follow link (href) in instant results and refine search results
  • highlighted result title text based on what the user typed in

The Autosuggest Entrypoint is a Places (Search) API Core entrypoint.

Entrypoint URI

/autosuggest

Entrypoint Parameters

Parameter Type Description
at Position (format: latitude,longitude[;cgen=(map|gps|sgps)][;u=\d+]); required, unless one of the Geolocation or X-Map-Viewport headers or the in are set. Coordinates of search location expressed as latitude, longitude. Additional parameters can be passed which provide more context such as the uncertainty and how the coordinates were generated. For example, "52.5304417,13.4111201", "52.5304417,13.4111201;cgen=gps;u=100" or "52.5304417,13.4111201;u=100". For a full description, see the Location Contexts documentation.
q String; required Plain-text search term. For example, "restaurant" or "Brandenburger Tor"
in Area; required, unless one of the Geolocation or X-Map-Viewport headers or the at parameter are set. This parameter limits results to the boundary of the specified area. The search area can be expressed as:
  • circle specified as a centre point with latitude and longitude; and a radius around that point. Format: latitude,longitude;r=\\d+(\\.\\d+)?[;cgen=(map|gps|sgps)][;u=\\d+]
  • bounding box specified as 4 values, denoting west longitude, south latitude, east longitude, north latitude.
  • polygon (Experimental) defined by the coordinates (latitude, longitude) of each of the polygon's point. At least 4 coordinates (8 values) are required. The first and the last coordinate must be the same
For a full description, see the Location Contexts documentation.
result_types Comma-separated list of result type strings; optional A list of the autosuggest result types that should be included in the response. Possible values are: address, place, category, chain. If this parameter is not set, all autosuggest types are considered for the response.
hlStart String; optional The delimiter that should be placed before each matched token in the autosuggest response. It defaults to</b>. The delimiters are included in the 'highlightedTitle' and 'highlightedVicinity' fields.
hlEnd String; optional The delimiter that should be placed after each matched token in the autosuggest response. It defaults to </b>. The delimiters are included in the 'highlightedTitle' and 'highlightedVicinity' fields.

GET Method

The GET method returns the list of suggested queries, places and address as well as query completions related to the partial search term.

The method allows applications to provide to application users query completion suggestions as they type.

Representation Modifiers

The following options are available in this context:

Parameter Type Description
size Number (non-negative integer); optional The maximum number of result items in each collection.

For additional information and examples, see Representation Modifiers.

Response Media Type

Responses to requests to this endpoint will have the urn:nlp-types:autosuggest media type. See the urn:nlp-types:autosuggest media type documentation for details about the structure and content of the response.

Request Example

https://places.cit.api.here.com/places/v1/autosuggest
?app_id={YOUR_APP_ID}
&app_code={YOUR_APP_CODE}
&at=52.5304417,13.4111201
&q=rest
&pretty

Response Example

{
  "results": [
    {
      "title": "restaurant",
      "highlightedTitle": "<b>rest</b>aurant",
      "category": "restaurant",
      "href": "https://...",
      "type": "urn:nlp-types:search"
    },
    {
      "title": "rest area",
      "highlightedTitle": "<b>rest</b> area",
      "category": "toilet-rest-area",
      "href": "https://...",
      "type": "urn:nlp-types:search"
    },
    ...,
    {
      "title": "Restaurant im Fernsehturm",
      "highlightedTitle": "<b>Rest</b>aurant im Fernsehturm",
      "vicinity": "Panoramastraße 1<br/>10178 Berlin",
      "highlightedVicinity": "Panoramastraße 1<br/>10178 Berlin",
      "position": [ 52.52131, 13.40971 ],
      "category": "sights-museums",
      "href": "https://...",
      "type": "urn:nlp-types:place"
    },
    {
      "title": "Restaurant Marinelli",
      "highlightedTitle": "<b>Rest</b>aurant Marinelli",
      "vicinity": "Anhalter Straße 1<br/>10963 Berlin",
      "highlightedVicinity": "Anhalter Straße 1<br/>10963 Berlin",
      "position": [ 52.50461, 13.38277 ],
      "category": "restaurant",
      "href": "https://...",
      "type": "urn:nlp-types:place"
    },
    ...,
    {
      "title": "<b>Rest</b>aurant",
      "completion": "aurant",
      "type": "urn:nlp-types:autosuggest"
    }
  ]
}

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.