Skip to content

Places API

Client for the HERE Places API.

PlacesApi

Bases: HEREApi

A python interface into the HERE Places (Search) API.

Source code in src/herepy/places_api.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
class PlacesApi(HEREApi):
    """A python interface into the HERE Places (Search) API."""

    def __init__(self, api_key: str = None, timeout: int = None):
        """
        Initialize the Places API client.

        Args:
          api_key (str):
            API key taken from HERE Developer Portal.
          timeout (int):
            Timeout limit for requests.

        """
        super().__init__(api_key, timeout)
        self._base_url = "https://discover.search.hereapi.com/v1/discover"

    def __get(self, data):
        url = Utils.build_url(self._base_url, extra_params=data)
        response = requests.get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get("items") is not None:
            return PlacesResponse.new_from_jsondict(json_data)
        elif "error" in json_data:
            if json_data["error"] == "Unauthorized":
                raise UnauthorizedError(json_data["error_description"])
        else:
            raise HEREError(json_data.get("message", "Error occurred on " + sys._getframe(1).f_code.co_name))

    def onebox_search(self, coordinates: list[float], query: str, limit: int = 20, lang: str = "en-US") -> PlacesResponse | None:
        """
        Request a list of places based on a query string.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          query (str):
            search term.
          limit (int):
            Limits items to return, with default value 10. Max value 100.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          PlacesResponse
        Raises:
          HEREError

        """
        data = {
            "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
            "q": query,
            "limit": limit,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return self.__get(data)

    def search_in_country(
        self,
        coordinates: list[float],
        query: str,
        country_code: str,
        limit: int = 20,
        lang: str = "en-US",
    ) -> PlacesResponse | None:
        """
        Request a list of places based on a query string.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          query (str):
            search term.
          country_code (str):
            ISO 3166-1 alpha-3 country code.
          limit (int):
            Limits items to return. Max value 100.
          lang (str):
            BCP47 compliant Language Code
        Returns:
          PlacesResponse
        Raises:
          HEREError

        """
        data = {
            "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
            "q": query,
            "limit": limit,
            "in": "countryCode:" + country_code,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return self.__get(data)

    def places_in_circle(
        self,
        coordinates: list[float],
        radius: int,
        query: str,
        limit: int = 20,
        lang: str = "en-US",
    ) -> PlacesResponse | None:
        """
        Request a list of popular places around a location.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          radius (int):
            Circle radius (in meters).
          query (str):
            search term.
          limit (int):
            Maximum number of places to return.
          lang (str):
            BCP47 compliant Language Code

        Returns:
          PlacesResponse
        Raises:
          HEREError.

        """
        data = {
            "in": str.format("circle:{0},{1};r={2}", coordinates[0], coordinates[1], radius),
            "q": query,
            "limit": limit,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return self.__get(data)

    async def __get_async(self, data):
        url = Utils.build_url(self._base_url, extra_params=data)
        response = await self._get_async_client().get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get("items") is not None:
            return PlacesResponse.new_from_jsondict(json_data)
        elif "error" in json_data:
            if json_data["error"] == "Unauthorized":
                raise UnauthorizedError(json_data["error_description"])
        else:
            raise HEREError(json_data.get("message", "Error occurred on " + sys._getframe(1).f_code.co_name))

    async def async_onebox_search(
        self, coordinates: list[float], query: str, limit: int = 20, lang: str = "en-US"
    ) -> PlacesResponse | None:
        """
        Request a list of places based on a query string.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          query (str):
            search term.
          limit (int):
            Limits items to return, with default value 10. Max value 100.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          PlacesResponse
        Raises:
          HEREError

        """
        data = {
            "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
            "q": query,
            "limit": limit,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return await self.__get_async(data)

    async def async_search_in_country(
        self,
        coordinates: list[float],
        query: str,
        country_code: str,
        limit: int = 20,
        lang: str = "en-US",
    ) -> PlacesResponse | None:
        """
        Request a list of places based on a query string.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          query (str):
            search term.
          country_code (str):
            ISO 3166-1 alpha-3 country code.
          limit (int):
            Limits items to return. Max value 100.
          lang (str):
            BCP47 compliant Language Code
        Returns:
          PlacesResponse
        Raises:
          HEREError

        """
        data = {
            "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
            "q": query,
            "limit": limit,
            "in": "countryCode:" + country_code,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return await self.__get_async(data)

    async def async_places_in_circle(
        self,
        coordinates: list[float],
        radius: int,
        query: str,
        limit: int = 20,
        lang: str = "en-US",
    ) -> PlacesResponse | None:
        """
        Request a list of popular places around a location.

        Args:
          coordinates (List):
            List contains latitude and longitude in order.
          radius (int):
            Circle radius (in meters).
          query (str):
            search term.
          limit (int):
            Maximum number of places to return.
          lang (str):
            BCP47 compliant Language Code

        Returns:
          PlacesResponse
        Raises:
          HEREError.

        """
        data = {
            "in": str.format("circle:{0},{1};r={2}", coordinates[0], coordinates[1], radius),
            "q": query,
            "limit": limit,
            "lang": lang,
            "apiKey": self._api_key,
        }
        return await self.__get_async(data)

__init__(api_key=None, timeout=None)

Initialize the Places API client.

Parameters:

Name Type Description Default
api_key str

API key taken from HERE Developer Portal.

 None
timeout int

Timeout limit for requests.

 None
Source code in src/herepy/places_api.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
def __init__(self, api_key: str = None, timeout: int = None):
    """
    Initialize the Places API client.

    Args:
      api_key (str):
        API key taken from HERE Developer Portal.
      timeout (int):
        Timeout limit for requests.

    """
    super().__init__(api_key, timeout)
    self._base_url = "https://discover.search.hereapi.com/v1/discover"

Request a list of places based on a query string.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
query str

search term.

 required
limit int

Limits items to return, with default value 10. Max value 100.

 20
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
PlacesResponse | None

PlacesResponse

Raises: HEREError

Source code in src/herepy/places_api.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
async def async_onebox_search(
    self, coordinates: list[float], query: str, limit: int = 20, lang: str = "en-US"
) -> PlacesResponse | None:
    """
    Request a list of places based on a query string.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      query (str):
        search term.
      limit (int):
        Limits items to return, with default value 10. Max value 100.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      PlacesResponse
    Raises:
      HEREError

    """
    data = {
        "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
        "q": query,
        "limit": limit,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return await self.__get_async(data)

async_places_in_circle(coordinates, radius, query, limit=20, lang='en-US') async

Request a list of popular places around a location.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
radius int

Circle radius (in meters).

 required
query str

search term.

 required
limit int

Maximum number of places to return.

 20
lang str

BCP47 compliant Language Code

 'en-US'

Returns:

Type Description
PlacesResponse | None

PlacesResponse

Raises: HEREError.

Source code in src/herepy/places_api.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
async def async_places_in_circle(
    self,
    coordinates: list[float],
    radius: int,
    query: str,
    limit: int = 20,
    lang: str = "en-US",
) -> PlacesResponse | None:
    """
    Request a list of popular places around a location.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      radius (int):
        Circle radius (in meters).
      query (str):
        search term.
      limit (int):
        Maximum number of places to return.
      lang (str):
        BCP47 compliant Language Code

    Returns:
      PlacesResponse
    Raises:
      HEREError.

    """
    data = {
        "in": str.format("circle:{0},{1};r={2}", coordinates[0], coordinates[1], radius),
        "q": query,
        "limit": limit,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return await self.__get_async(data)

async_search_in_country(coordinates, query, country_code, limit=20, lang='en-US') async

Request a list of places based on a query string.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
query str

search term.

 required
country_code str

ISO 3166-1 alpha-3 country code.

 required
limit int

Limits items to return. Max value 100.

 20
lang str

BCP47 compliant Language Code

 'en-US'

Returns: PlacesResponse Raises: HEREError

Source code in src/herepy/places_api.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
async def async_search_in_country(
    self,
    coordinates: list[float],
    query: str,
    country_code: str,
    limit: int = 20,
    lang: str = "en-US",
) -> PlacesResponse | None:
    """
    Request a list of places based on a query string.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      query (str):
        search term.
      country_code (str):
        ISO 3166-1 alpha-3 country code.
      limit (int):
        Limits items to return. Max value 100.
      lang (str):
        BCP47 compliant Language Code
    Returns:
      PlacesResponse
    Raises:
      HEREError

    """
    data = {
        "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
        "q": query,
        "limit": limit,
        "in": "countryCode:" + country_code,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return await self.__get_async(data)

Request a list of places based on a query string.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
query str

search term.

 required
limit int

Limits items to return, with default value 10. Max value 100.

 20
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
PlacesResponse | None

PlacesResponse

Raises: HEREError

Source code in src/herepy/places_api.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def onebox_search(self, coordinates: list[float], query: str, limit: int = 20, lang: str = "en-US") -> PlacesResponse | None:
    """
    Request a list of places based on a query string.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      query (str):
        search term.
      limit (int):
        Limits items to return, with default value 10. Max value 100.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      PlacesResponse
    Raises:
      HEREError

    """
    data = {
        "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
        "q": query,
        "limit": limit,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return self.__get(data)

places_in_circle(coordinates, radius, query, limit=20, lang='en-US')

Request a list of popular places around a location.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
radius int

Circle radius (in meters).

 required
query str

search term.

 required
limit int

Maximum number of places to return.

 20
lang str

BCP47 compliant Language Code

 'en-US'

Returns:

Type Description
PlacesResponse | None

PlacesResponse

Raises: HEREError.

Source code in src/herepy/places_api.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def places_in_circle(
    self,
    coordinates: list[float],
    radius: int,
    query: str,
    limit: int = 20,
    lang: str = "en-US",
) -> PlacesResponse | None:
    """
    Request a list of popular places around a location.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      radius (int):
        Circle radius (in meters).
      query (str):
        search term.
      limit (int):
        Maximum number of places to return.
      lang (str):
        BCP47 compliant Language Code

    Returns:
      PlacesResponse
    Raises:
      HEREError.

    """
    data = {
        "in": str.format("circle:{0},{1};r={2}", coordinates[0], coordinates[1], radius),
        "q": query,
        "limit": limit,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return self.__get(data)

search_in_country(coordinates, query, country_code, limit=20, lang='en-US')

Request a list of places based on a query string.

Parameters:

Name Type Description Default
coordinates List

List contains latitude and longitude in order.

 required
query str

search term.

 required
country_code str

ISO 3166-1 alpha-3 country code.

 required
limit int

Limits items to return. Max value 100.

 20
lang str

BCP47 compliant Language Code

 'en-US'

Returns: PlacesResponse Raises: HEREError

Source code in src/herepy/places_api.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def search_in_country(
    self,
    coordinates: list[float],
    query: str,
    country_code: str,
    limit: int = 20,
    lang: str = "en-US",
) -> PlacesResponse | None:
    """
    Request a list of places based on a query string.

    Args:
      coordinates (List):
        List contains latitude and longitude in order.
      query (str):
        search term.
      country_code (str):
        ISO 3166-1 alpha-3 country code.
      limit (int):
        Limits items to return. Max value 100.
      lang (str):
        BCP47 compliant Language Code
    Returns:
      PlacesResponse
    Raises:
      HEREError

    """
    data = {
        "at": str.format("{0},{1}", coordinates[0], coordinates[1]),
        "q": query,
        "limit": limit,
        "in": "countryCode:" + country_code,
        "lang": lang,
        "apiKey": self._api_key,
    }
    return self.__get(data)