Places (Search) API Developer's Guide

Voice Search Entrypoint

The Voice Entrypoint processes text string queries based on the user's voice input to find specific places. It answers questions of "what" and "where" for an online search of POI or address.

The results of the Voice Entrypoint are sets of places that match a user's search term in a specific location context (such as near a given location, around a user's current position or on the currently visible map).

The Voice Search Entrypoint is a Places (Search) API Premium entrypoint.

Note:

This is a premium feature. Contact your HERE representative or contact us through developer.here.com to request the appropriate license if this feature is not already covered by your agreement.

Entrypoint URI

/discover/voice

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.
cs Comma-separated list; optional A comma-separated ordered list of category systems defining which type of category systems should be returned in the response. For example cs=places,cuisines

GET Method

The GET method provides access to places matching the given term.

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.
Supported values are:
  • html
  • plain
show_refs Comma-separated list; optional A list of one or more external system names or reference types. This parameter exposes place related external references in response. For a full description see Representation Modifiers documentation.
show_content Comma-separated list; optional A list of one or more available content types you can add to the response. For a full description see Representation Modifiers documentation.

For additional information and examples, see Representation Modifiers.

Response Media Type

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

Request Example

https://places.cit.api.here.com/places/v1/discover/voice
?app_id={YOUR_APP_ID}
&app_code={YOUR_APP_CODE}
&at=52.521,13.3807
&q=Find+me+Munich
&pretty

Response Example

{
  "results": {
    "items": [
      {
        "position": [ 48.13641, 11.57754 ],
        "bbox": [ 11.36772, 48.06307, 11.72033, 48.24597],
        "distance": 504295,
        "title": "Munich",
        "category": {
          "id": "city-town-village",
          "title": "City, Town or Village",
          "href": "http://...",
          "type": "urn:nlp-types:category",
          "system": "places"
        },
        "icon": "http://...",
        "vicinity": "Bavaria<br/>Germany",
        "having": [],
        "type": "urn:nlp-types:place",
        "href": "http://...",
        "id": "276u281z-0b68e34139d74c61ac81ce05264aa4b6"
      },
      {
        "position": [ 48.3583, 11.78427 ],
        "distance": 476701,
        "title": "Munich Airport (MUC)",
        "averageRating": 4.8,
        "category": {
          "id": "airport",
          "title": "Airport",
          "href": "http://...",
          "type": "urn:nlp-types:category",
          "system": "places"
        },
        "icon": "https://...",
        "vicinity": "Terminalstraße West<br/>85356 Oberding",
        "having": [],
        "type": "urn:nlp-types:place",
        "href": "http://...",
        "id": "276u287h-33978e49adeb4b2fa026780cb8d88bef"
      },
      {
        "position": [ 52.511929, 13.45483 ],
        "distance": 5133,
        "title": "Munich Sedcard Berlin",
        "averageRating": 0,
        "category": {
          "id": "business-services",
          "title": "Business & Services",
          "href": "http://...",
          "type": "urn:nlp-types:category",
          "system": "places"
        },
        "icon": "http://...",
        "vicinity": "Grünberger Str. 48<br/>10245 Berlin",
        "having": [],
        "type": "urn:nlp-types:place",
        "href": "http://...",
        "id": "2768lxx5-73767d4de52d09c962f15cb017d9ef19"
      }
    ]
  },
  "search": {
    "context": {
      "location": {
        "position": [ 52.521, 13.3807 ],
        "address": {
          "text": "Luisenstraße 35<br/>10117 Berlin<br/>Germany",
          "house": "35",
          "street": "Luisenstraße",
          "postalCode": "10117",
          "district": "Mitte",
          "city": "Berlin",
          "county": "Berlin",
          "stateCode": "Berlin",
          "country": "Germany",
          "countryCode": "DEU"
        }
      },
      "type": "urn:nlp-types:place",
      "href": "http://..."
    }
  }
}

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.