Skip to content

Geocoder API

GeocoderApi

A python interface into the HERE Geocoder 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_api.py
17
18
19
20
21
22
23
24
25
26
27
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(GeocoderApi, self).__init__(api_key, timeout)
    self._base_url = "https://geocode.search.hereapi.com/v1/geocode"

address_with_boundingbox(self, 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[float]

List contains latitude and longitude in order.

required
bottom_right List[float]

List contains latitude and longitude in order.

required
lang str

BCP47 compliant Language Code.

'en-US'

Returns:

Type Description
Optional[herepy.models.GeocoderResponse]

GeocoderResponse

Source code in herepy/geocoder_api.py
 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
def address_with_boundingbox(
    self,
    searchtext: str,
    top_left: List[float],
    bottom_right: List[float],
    lang: str = "en-US",
) -> Optional[GeocoderResponse]:
    """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(self, house_number, street, city, country, lang='en-US')

Geocodes with given address details

Parameters:

Name Type Description Default
house_number int

house number.

required
street str

street name.

required
city str

city name.

required
country str

country name.

required
lang str

BCP47 compliant Language Code.

'en-US'

Returns:

Type Description
Optional[herepy.models.GeocoderResponse]

GeocoderResponse

Source code in herepy/geocoder_api.py
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
def address_with_details(
    self,
    house_number: int,
    street: str,
    city: str,
    country: str,
    lang: str = "en-US",
) -> Optional[GeocoderResponse]:
    """Geocodes with given address details
    Args:
      house_number (int):
        house number.
      street (str):
        street name.
      city (str):
        city name.
      country (str):
        country name.
      lang (str):
        BCP47 compliant Language Code.
    Returns:
      GeocoderResponse
    Raises:
      HEREError"""

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

free_form(self, 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
Optional[herepy.models.GeocoderResponse]

GeocoderResponse

Source code in herepy/geocoder_api.py
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def free_form(
    self, searchtext: str, lang: str = "en-US"
) -> Optional[GeocoderResponse]:
    """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(self, 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
Optional[herepy.models.GeocoderResponse]

GeocoderResponse

Source code in herepy/geocoder_api.py
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def street_intersection(
    self, street: str, city: str, lang: str = "en-US"
) -> Optional[GeocoderResponse]:
    """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)