Skip to content

Reverse Geocoder API

GeocoderReverseApi

A python interface into the HERE Geocoder Reverse API

__init__(self, api_key=None, timeout=None) special

Returns 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 herepy/geocoder_reverse_api.py
16
17
18
19
20
21
22
23
24
25
26
27
28
def __init__(self,
             api_key: str=None,
             timeout: int=None):
    """Returns a GeocoderApi instance.
    Args:
      api_key (str):
        API key taken from HERE Developer Portal.
      timeout (int):
        Timeout limit for requests.
    """

    super(GeocoderReverseApi, self).__init__(api_key, timeout)
    self._base_url = 'https://revgeocode.search.hereapi.com/v1/revgeocode'

retrieve_addresses(self, prox, limit=1, lang='en-US')

Gets the address information of a point.

Parameters:

Name Type Description Default
prox List[float]

latitude longitude of the point

required
limit int

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

1
lang str

BCP47 compliant Language Code.

'en-US'

Returns:

Type Description
Optional[herepy.models.GeocoderReverseResponse]

GeocoderReverseResponse

Source code in herepy/geocoder_reverse_api.py
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def retrieve_addresses(self, prox: List[float], limit: int=1, lang: str='en-US') -> Optional[GeocoderReverseResponse]:
    """Gets the address information of a point.
    Args:
      prox (lat/lon):
        latitude longitude of the point
      limit (int):
        Limits items to return, with default value 1. Max value 100.
      lang (str):
        BCP47 compliant Language Code.
    Returns:
      GeocoderReverseResponse
    Raises:
      HEREError"""

    data = {'at': str.format('{0},{1}', prox[0], prox[1]),
            'limit': limit,
            'lang': lang,
            'apiKey': self._api_key}
    return self.__get(data)