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

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.
tf String; optional; default: html. Text format. Determines how rich text properties such as location.address.text should be rendered. Note: plain text can still be multiline. In this case newline symbol ("\n") is used to separate lines.
Supported values are:
  • html
  • plain

For additional information and examples, see Changing Responses with 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.sit.ls.hereapi.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",
            "resultType":"category"
        },
        {
            "title": "rest area",
            "highlightedTitle": "<b>rest</b> area",
            "category": "toilet-rest-area",
            "href": "https://...",
            "type": "urn:nlp-types:search",
            "resultType":"category"
        },
        ...,
        {
            "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",
            "categoryTitle": "Sights & Museums",
            "href": "https://...",
            "type": "urn:nlp-types:place",
            "resultType":"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",
            "categoryTitle": "Restaurant",
            "href": "https://...",
            "type": "urn:nlp-types:place",
            "resultType":"place"
        },
        ...,
        {
            "title": "<b>Rest</b>aurant",
            "completion": "aurant",
            "type": "urn:nlp-types:autosuggest",
            "resultType":"query"
        }
    ]
}