Places (Search) API Developer's Guide

Media Collection

A media collection object provides access to additional content for a place.

All media properties are paginateable collections. When a given media collection is not available for a place, the attribute for that collection is not present.

Some media elements might support additional features, in which case individual media elements are also link-objects pointing to a full media resource with hyperlinks for the available features.

Attribute Type Description
available Number (integer) The total number of items available for a place, i.e. this would be 50 for a place with 50 images.
Note: It is not possible to always calculate the total number of elements in a collection. So the attribute might be missing, or just contain an estimate. Clients MUST not rely on the presence of the attribute but instead rely only on the existence of the next attribute to find out if additional items are available.
offset Number (positive integer); optional Pages other than the first page of a collection may include this attribute. If present, it contains the index of the first item in the current page.
previous String (URI); optional The URI to the subresource holding the previous page of the collection. If the current page is the first page of the collection, the attribute is not present.
next String (URI); optional The URI to the subresource holding the next page of the collection. If the current page is the last page of the collection, the attribute is not present.
items Array[ActionLink | PlaceArticle | PlaceEditorial | PlaceImage | PlaceRatingsSummary | PlaceReview] An array containing the objects of the current page of the collection (eg. images). If a collection is empty, the items attribute is not present. The type of the objects in the array depend on the collection. It may be for example Editorial Items or Review Items

Action Link

This object represents a link to a Uri for interacting with a place, for example booking a table at a restaurant.

Attribute Type Description
id String; optional Identifier of the link
url String (URI) The URI of the link.
title String The title of the link
supplier Object[Link] A link to metadata about the supplier of the link. The object extends the standard link object with an optional icon attribute that contains a URI string pointing to the supplier's brand icon.

PlaceEditorial

A Place Editorial object provides access to editorial descriptions about the place.

Attribute Type Description
description String (formatted text) The editorial content.
language String (RFC 5646 language tag); optional A language code indicating what language the review is in, if known.
via Object[Link]; optional  
supplier Object[Link]; optional  
attribution String (formatted text); optional  

PlaceImage

A Place Image object provides access to an image attached to the place.

Attribute Type Description
src String (URI) A URL to the actual image
id String; optional Identifier of image if uploaded via Places (Search) API (this ID is returned from an image upload response)
href String (URI); optional A hyperlink that refers to the image object of this item.
type String; optional  
date String (RFC 3339 date-time); optional The date the image was uploaded.
dimensions Object(map of String to String); optional A map containing links to the sized variants of the original image.
user Object[User]; optional Details of the user who contributed the image.
title String; optional A localized title to be displayed for this element
via Object[Link]; optional  
supplier Object[Link]; optional  
attribution String (formatted text); optional  

PlaceReview

A Place Review object provides access to review and ratings given by other users.

Attribute Type Description
id String; optional Identifier of review if uploaded via Places (Search) API (this ID is returned from a review uploaded response).
href String (URI); optional A hyperlink that refers to the review object of this item.
type String; optional  
date String (RFC 3339 date-time); optional The review date
title String; optional The title the user gave to the review.
rating Number; optional The rating that the writer of the review gave to the place. Note: Ratings may come from various systems with different rating schemes. The value of that attribute may not reflect the rating scheme of the supplier's service, but is adjusted to the value range of the Places (Search) API (1..5).
description String (formatted text) The review content. Depending on the supplier it might not display the full content and the full review is only available on the resource linked by the via property.
user Object[User]; optional Details of the user who contributed the review.
language String (RFC 5646 language tag); optional A language code indicating what language the review is in, if known
via Object[Link]; optional  
supplier Object[Link]; optional  
attribution String (formatted text); optional  

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.