Skip to content

Geocoder API

Module for the HERE Geocoder API.

GeocoderApi

Bases: HEREApi

A python interface into the HERE Geocoder API.

Source code in src/herepy/geocoder_api.py 
 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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
class GeocoderApi(HEREApi):
    """A python interface into the HERE Geocoder API."""

    def __init__(self, api_key: str = None, timeout: int = None):
        """
        Initialize a GeocoderApi instance.

        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://geocode.search.hereapi.com/v1/geocode"

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

    def free_form(self, searchtext: str, lang: str = "en-US") -> GeocoderResponse | None:
        """
        Geocodes given search text.

        Args:
          searchtext (str):
            possible address text.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {"q": searchtext, "apiKey": self._api_key, "lang": lang}
        return self.__get(data)

    def address_with_boundingbox(
        self,
        searchtext: str,
        top_left: list[float],
        bottom_right: list[float],
        lang: str = "en-US",
    ) -> GeocoderResponse | None:
        """
        Geocodes given search text with in given boundingbox.

        Args:
          searchtext (str):
            possible address text.
          top_left (List):
            List contains latitude and longitude in order.
          bottom_right (List):
            List contains latitude and longitude in order.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {
            "q": searchtext,
            "mapView": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "apiKey": self._api_key,
            "lang": lang,
        }
        return self.__get(data)

    def address_with_details(
        self,
        house_number: int | None = None,
        street: str | None = None,
        city: str | None = None,
        postal_code: str | None = None,
        country: str | None = None,
        lang: str = "en-US",
    ) -> GeocoderResponse | None:
        """
        Geocodes with given address details.

        Args:
          house_number (int):
            house number.
          street (str):
            street name.
          city (str):
            city name.
          country (str):
            country name.
          postal_code (str):
            postal code.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        qq_params = []
        if house_number is not None:
            qq_params.append(f"houseNumber={house_number}")
        if street:
            qq_params.append(f"street={street}")
        if city:
            qq_params.append(f"city={city}")
        if postal_code:
            qq_params.append(f"postalCode={postal_code}")
        if country:
            qq_params.append(f"country={country}")

        if len(qq_params) == 0:
            raise HEREError("At least one of the parameters should be provided")

        data = {
            "qq": ";".join(qq_params),
            "apiKey": self._api_key,
            "lang": lang,
        }
        return self.__get(data)

    def street_intersection(self, street: str, city: str, lang: str = "en-US") -> GeocoderResponse | None:
        """
        Geocodes with given street and city.

        Args:
          street (str):
            street name.
          city (str):
            city name.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {
            "qq": str.format("street={0};", street) + str.format("city={0}", city),
            "apiKey": self._api_key,
            "lang": lang,
        }
        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)
        try:
            json_data = json.loads(response.content.decode("utf8"))
            if json_data.get("items") is not None:
                return GeocoderResponse.new_from_jsondict(json_data)
            elif json_data["error"] == "Unauthorized":
                raise UnauthorizedError(json_data["error_description"])
            else:
                raise HEREError(
                    json_data.get(
                        "Details",
                        "Error occurred on function " + sys._getframe(1).f_code.co_name,
                    )
                )
        except ValueError as err:
            raise HEREError("Error occurred on function " + sys._getframe(1).f_code.co_name + " " + str(err))

    async def async_free_form(self, searchtext: str, lang: str = "en-US") -> GeocoderResponse | None:
        """
        Geocodes given search text.

        Args:
          searchtext (str):
            possible address text.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {"q": searchtext, "apiKey": self._api_key, "lang": lang}
        return await self.__get_async(data)

    async def async_address_with_boundingbox(
        self,
        searchtext: str,
        top_left: list[float],
        bottom_right: list[float],
        lang: str = "en-US",
    ) -> GeocoderResponse | None:
        """
        Geocodes given search text with in given boundingbox.

        Args:
          searchtext (str):
            possible address text.
          top_left (List):
            List contains latitude and longitude in order.
          bottom_right (List):
            List contains latitude and longitude in order.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {
            "q": searchtext,
            "mapView": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "apiKey": self._api_key,
            "lang": lang,
        }
        return await self.__get_async(data)

    async def async_address_with_details(
        self,
        house_number: int | None = None,
        street: str | None = None,
        city: str | None = None,
        postal_code: str | None = None,
        country: str | None = None,
        lang: str = "en-US",
    ) -> GeocoderResponse | None:
        """
        Geocodes with given address details.

        Args:
          house_number (int):
            house number.
          street (str):
            street name.
          city (str):
            city name.
          country (str):
            country name.
          postal_code (str):
            postal code.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        qq_params = []
        if house_number is not None:
            qq_params.append(f"houseNumber={house_number}")
        if street:
            qq_params.append(f"street={street}")
        if city:
            qq_params.append(f"city={city}")
        if postal_code:
            qq_params.append(f"postalCode={postal_code}")
        if country:
            qq_params.append(f"country={country}")

        if len(qq_params) == 0:
            raise HEREError("At least one of the parameters should be provided")

        data = {
            "qq": ";".join(qq_params),
            "apiKey": self._api_key,
            "lang": lang,
        }
        return await self.__get_async(data)

    async def async_street_intersection(self, street: str, city: str, lang: str = "en-US") -> GeocoderResponse | None:
        """
        Geocodes with given street and city.

        Args:
          street (str):
            street name.
          city (str):
            city name.
          lang (str):
            BCP47 compliant Language Code.

        Returns:
          GeocoderResponse
        Raises:
          HEREError

        """
        data = {
            "qq": str.format("street={0};", street) + str.format("city={0}", city),
            "apiKey": self._api_key,
            "lang": lang,
        }
        return await self.__get_async(data)

__init__(api_key=None, timeout=None)

Initialize a GeocoderApi instance.

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/geocoder_api.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
def __init__(self, api_key: str = None, timeout: int = None):
    """
    Initialize a GeocoderApi instance.

    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://geocode.search.hereapi.com/v1/geocode"

address_with_boundingbox(searchtext, top_left, bottom_right, lang='en-US')

Geocodes given search text with in given boundingbox.

Parameters:

Name Type Description Default
searchtext str

possible address text.

 required
top_left List

List contains latitude and longitude in order.

 required
bottom_right List

List contains latitude and longitude in order.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
 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
def address_with_boundingbox(
    self,
    searchtext: str,
    top_left: list[float],
    bottom_right: list[float],
    lang: str = "en-US",
) -> GeocoderResponse | None:
    """
    Geocodes given search text with in given boundingbox.

    Args:
      searchtext (str):
        possible address text.
      top_left (List):
        List contains latitude and longitude in order.
      bottom_right (List):
        List contains latitude and longitude in order.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {
        "q": searchtext,
        "mapView": str.format(
            "{0},{1};{2},{3}",
            top_left[0],
            top_left[1],
            bottom_right[0],
            bottom_right[1],
        ),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return self.__get(data)

address_with_details(house_number=None, street=None, city=None, postal_code=None, country=None, lang='en-US')

Geocodes with given address details.

Parameters:

Name Type Description Default
house_number int

house number.

 None
street str

street name.

 None
city str

city name.

 None
country str

country name.

 None
postal_code str

postal code.

 None
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def address_with_details(
    self,
    house_number: int | None = None,
    street: str | None = None,
    city: str | None = None,
    postal_code: str | None = None,
    country: str | None = None,
    lang: str = "en-US",
) -> GeocoderResponse | None:
    """
    Geocodes with given address details.

    Args:
      house_number (int):
        house number.
      street (str):
        street name.
      city (str):
        city name.
      country (str):
        country name.
      postal_code (str):
        postal code.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    qq_params = []
    if house_number is not None:
        qq_params.append(f"houseNumber={house_number}")
    if street:
        qq_params.append(f"street={street}")
    if city:
        qq_params.append(f"city={city}")
    if postal_code:
        qq_params.append(f"postalCode={postal_code}")
    if country:
        qq_params.append(f"country={country}")

    if len(qq_params) == 0:
        raise HEREError("At least one of the parameters should be provided")

    data = {
        "qq": ";".join(qq_params),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return self.__get(data)

async_address_with_boundingbox(searchtext, top_left, bottom_right, lang='en-US') async

Geocodes given search text with in given boundingbox.

Parameters:

Name Type Description Default
searchtext str

possible address text.

 required
top_left List

List contains latitude and longitude in order.

 required
bottom_right List

List contains latitude and longitude in order.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
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
async def async_address_with_boundingbox(
    self,
    searchtext: str,
    top_left: list[float],
    bottom_right: list[float],
    lang: str = "en-US",
) -> GeocoderResponse | None:
    """
    Geocodes given search text with in given boundingbox.

    Args:
      searchtext (str):
        possible address text.
      top_left (List):
        List contains latitude and longitude in order.
      bottom_right (List):
        List contains latitude and longitude in order.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {
        "q": searchtext,
        "mapView": str.format(
            "{0},{1};{2},{3}",
            top_left[0],
            top_left[1],
            bottom_right[0],
            bottom_right[1],
        ),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return await self.__get_async(data)

async_address_with_details(house_number=None, street=None, city=None, postal_code=None, country=None, lang='en-US') async

Geocodes with given address details.

Parameters:

Name Type Description Default
house_number int

house number.

 None
street str

street name.

 None
city str

city name.

 None
country str

country name.

 None
postal_code str

postal code.

 None
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
async def async_address_with_details(
    self,
    house_number: int | None = None,
    street: str | None = None,
    city: str | None = None,
    postal_code: str | None = None,
    country: str | None = None,
    lang: str = "en-US",
) -> GeocoderResponse | None:
    """
    Geocodes with given address details.

    Args:
      house_number (int):
        house number.
      street (str):
        street name.
      city (str):
        city name.
      country (str):
        country name.
      postal_code (str):
        postal code.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    qq_params = []
    if house_number is not None:
        qq_params.append(f"houseNumber={house_number}")
    if street:
        qq_params.append(f"street={street}")
    if city:
        qq_params.append(f"city={city}")
    if postal_code:
        qq_params.append(f"postalCode={postal_code}")
    if country:
        qq_params.append(f"country={country}")

    if len(qq_params) == 0:
        raise HEREError("At least one of the parameters should be provided")

    data = {
        "qq": ";".join(qq_params),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return await self.__get_async(data)

async_free_form(searchtext, lang='en-US') async

Geocodes given search text.

Parameters:

Name Type Description Default
searchtext str

possible address text.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
async def async_free_form(self, searchtext: str, lang: str = "en-US") -> GeocoderResponse | None:
    """
    Geocodes given search text.

    Args:
      searchtext (str):
        possible address text.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {"q": searchtext, "apiKey": self._api_key, "lang": lang}
    return await self.__get_async(data)

async_street_intersection(street, city, lang='en-US') async

Geocodes with given street and city.

Parameters:

Name Type Description Default
street str

street name.

 required
city str

city name.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
async def async_street_intersection(self, street: str, city: str, lang: str = "en-US") -> GeocoderResponse | None:
    """
    Geocodes with given street and city.

    Args:
      street (str):
        street name.
      city (str):
        city name.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {
        "qq": str.format("street={0};", street) + str.format("city={0}", city),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return await self.__get_async(data)

free_form(searchtext, lang='en-US')

Geocodes given search text.

Parameters:

Name Type Description Default
searchtext str

possible address text.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def free_form(self, searchtext: str, lang: str = "en-US") -> GeocoderResponse | None:
    """
    Geocodes given search text.

    Args:
      searchtext (str):
        possible address text.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {"q": searchtext, "apiKey": self._api_key, "lang": lang}
    return self.__get(data)

street_intersection(street, city, lang='en-US')

Geocodes with given street and city.

Parameters:

Name Type Description Default
street str

street name.

 required
city str

city name.

 required
lang str

BCP47 compliant Language Code.

 'en-US'

Returns:

Type Description
GeocoderResponse | None

GeocoderResponse

Raises: HEREError

Source code in src/herepy/geocoder_api.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
def street_intersection(self, street: str, city: str, lang: str = "en-US") -> GeocoderResponse | None:
    """
    Geocodes with given street and city.

    Args:
      street (str):
        street name.
      city (str):
        city name.
      lang (str):
        BCP47 compliant Language Code.

    Returns:
      GeocoderResponse
    Raises:
      HEREError

    """
    data = {
        "qq": str.format("street={0};", street) + str.format("city={0}", city),
        "apiKey": self._api_key,
        "lang": lang,
    }
    return self.__get(data)