Places (Search) API Developer's Guide

Place Categories Entrypoint

This entrypoint is used to obtain the place categories available for a given location. This entrypoint might be used to give a user a list of categories to choose from. The Place Categories Entrypoint represents sets of locally relevant categories that are organized in a directed acyclic graph. The category graph may change in the future and may differ depending on the location of the request. A set of permanent, top-level, place categories can be found at Categories.

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

Entrypoint URI

/categories/places

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.
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.
For a full description, see the Location Contexts documentation.

GET Method

The GET method provides access to the place categories relevant to a given position. When no such location is provided with the request, the response contains the graph with all place categories recognized by the API.

Response Media Type

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

Request Example

https://places.cit.api.here.com/places/v1/categories/places
?app_id={YOUR_APP_ID}
&app_code={YOUR_APP_CODE}
&at=52.50449,13.39091
&pretty

Response Example

{
  "items": [
    {
      "id": "eat-drink",
      "title": "Eat & Drink",
      "icon": "http://...",
      "type": "urn:nlp-types:category",
      "href": "http://...",
      "within": [ ]
    },
    {
      "id": "restaurant",
      "title": "Restaurant",
      "icon": "http://...",
      "type": "urn:nlp-types:category",
      "href": "http://...",
      "within": [ "eat-drink" ]
    },
    {
      "id": "snacks-fast-food",
      "title": "Snacks/Fast food",
      "icon": "http://...",
      "type": "urn:nlp-types:category",
      "href": "http://...",
      "within": [ "eat-drink" ]
    },
    ...
  ]
}