Skip to content

EV Charging Stations API

Module for the HERE EV Charging Stations API.

EVChargingStationsApi

Bases: HEREApi

A python interface into the HERE EV Charging Stations API.

Source code in src/herepy/ev_charging_stations_api.py 
 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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
class EVChargingStationsApi(HEREApi):
    """A python interface into the HERE EV Charging Stations API."""

    def __init__(self, api_key: str = None, timeout: int = None):
        """
        Initialize a EVChargingStationsApi 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://ev-v2.cit.cc.api.here.com/ev/"

    def __get(self, base_url, data, response_cls):
        url = Utils.build_url(base_url, extra_params=data)
        response = requests.get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get("evStations") is not None:
            return response_cls.new_from_jsondict(json_data)
        else:
            raise error_from_ev_charging_service_error(json_data)

    def __connector_types_str(self, connector_types: list[EVStationConnectorTypes]):
        connector_types_str = ""
        for connector_type in connector_types:
            connector_types_str += str.format("{0},", connector_type._value_)
        connector_types_str = connector_types_str[:-1]
        return connector_types_str

    def __corridor_str(self, points: list[float]):
        if len(points) % 2 != 0:
            points = points[:-1]
        corridor_str = ""
        for i in range(0, len(points), 2):
            corridor_str += str.format("{0},{1};", points[i], points[i + 1])
        corridor_str = corridor_str[:-1]
        return corridor_str

    def get_stations_circular_search(
        self,
        latitude: float,
        longitude: float,
        radius: int,
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Make a search request for charging stations.

        A circular search area defined by the latitude and longitude of its center
        (compliant with WGS 84) and an integer representing the radius of the area
        in meters, all separated by commas.

        Args:
          latitude (float):
            latitude.
          longitude (float):
            longitude.
          radius (int):
            Radius of circular area in meter. Radius can be a maximum of 200 km (200000).
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    def get_stations_bounding_box(
        self,
        top_left: list[float],
        bottom_right: list[float],
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Search for charging stations in a bounding box.

        The bounding box can have a maximum height or width of 400 km.

        Args:
          top_left (List):
            List contains latitude and longitude in order.
          bottom_right (List):
            List contains latitude and longitude in order.
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "bbox": str.format(
                    "{0},{1};{2},{3}",
                    top_left[0],
                    top_left[1],
                    bottom_right[0],
                    bottom_right[1],
                ),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "bbox": str.format(
                    "{0},{1};{2},{3}",
                    top_left[0],
                    top_left[1],
                    bottom_right[0],
                    bottom_right[1],
                ),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    def get_stations_corridor(
        self,
        points: list[float],
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Search for charging stations along a corridor.

        The maximum corridor area is 5000 km2.

        Args:
          points (List):
            List contains latitude and longitude pairs in order.
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "corridor": self.__corridor_str(points),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "corridor": self.__corridor_str(points),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    def get_station_details(self, station_id: str, maxresults: int = 50, offset: int = 0) -> EVChargingStationsResponse | None:
        """
        Retrieve the full/updated information about a single charging station only.

        Based on the results of a search for charging stations, this method
        retrieves the full/updated information about a single charging station only.

        Args:
          station_id (str):
            station_id is an attribute of the evStation element with a unique value.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        data = {"apiKey": self._api_key, "maxresults": maxresults, "offset": offset}
        url = self._base_url + "stations/" + station_id + ".json"
        response = self.__get(url, data, EVChargingStationsResponse)
        return response

    async def __get_async(self, base_url, data, response_cls):
        url = Utils.build_url(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("evStations") is not None:
            return response_cls.new_from_jsondict(json_data)
        else:
            raise error_from_ev_charging_service_error(json_data)

    async def async_get_stations_circular_search(
        self,
        latitude: float,
        longitude: float,
        radius: int,
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Make a search request for charging stations.

        A circular search area defined by the latitude and longitude of its center
        (compliant with WGS 84) and an integer representing the radius of the area
        in meters, all separated by commas.

        Args:
          latitude (float):
            latitude.
          longitude (float):
            longitude.
          radius (int):
            Radius of circular area in meter. Radius can be a maximum of 200 km (200000).
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    async def async_get_stations_bounding_box(
        self,
        top_left: list[float],
        bottom_right: list[float],
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Search for charging stations in a bounding box.

        The bounding box can have a maximum height or width of 400 km.

        Args:
          top_left (List):
            List contains latitude and longitude in order.
          bottom_right (List):
            List contains latitude and longitude in order.
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "bbox": str.format(
                    "{0},{1};{2},{3}",
                    top_left[0],
                    top_left[1],
                    bottom_right[0],
                    bottom_right[1],
                ),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "bbox": str.format(
                    "{0},{1};{2},{3}",
                    top_left[0],
                    top_left[1],
                    bottom_right[0],
                    bottom_right[1],
                ),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    async def async_get_stations_corridor(
        self,
        points: list[float],
        connectortypes: list[EVStationConnectorTypes] = None,
        maxresults: int = 50,
        offset: int = 0,
    ) -> EVChargingStationsResponse | None:
        """
        Search for charging stations along a corridor.

        The maximum corridor area is 5000 km2.

        Args:
          points (List):
            List contains latitude and longitude pairs in order.
          connectortypes (List[EVStationConnectorTypes]):
            Optional, to identify the connector types.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        if connectortypes:
            connector_types_str = self.__connector_types_str(connectortypes)
            data = {
                "apiKey": self._api_key,
                "corridor": self.__corridor_str(points),
                "connectortype": connector_types_str,
                "maxresults": maxresults,
                "offset": offset,
            }
        else:
            data = {
                "apiKey": self._api_key,
                "corridor": self.__corridor_str(points),
                "maxresults": maxresults,
                "offset": offset,
            }
        response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
        return response

    async def async_get_station_details(self, station_id: str, maxresults: int = 50, offset: int = 0) -> EVChargingStationsResponse | None:
        """
        Retrieve the full/updated information about a single charging station only.

        Based on the results of a search for charging stations, this method
        retrieves the full/updated information about a single charging station only.

        Args:
          station_id (str):
            station_id is an attribute of the evStation element with a unique value.
          maxresults (int):
            The maximum number of results a response can contain.
            This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
          offset (int):
            A value specifying the index of the first result. The offset together with the
            "maxresults" value can be used to support a paging mechanism on search results.
            This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

        Returns:
          EVChargingStationsResponse
        Raises:
          HEREError

        """
        data = {"apiKey": self._api_key, "maxresults": maxresults, "offset": offset}
        url = self._base_url + "stations/" + station_id + ".json"
        response = await self.__get_async(url, data, EVChargingStationsResponse)
        return response

__init__(api_key=None, timeout=None)

Initialize a EVChargingStationsApi 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/ev_charging_stations_api.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
def __init__(self, api_key: str = None, timeout: int = None):
    """
    Initialize a EVChargingStationsApi 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://ev-v2.cit.cc.api.here.com/ev/"

async_get_station_details(station_id, maxresults=50, offset=0) async

Retrieve the full/updated information about a single charging station only.

Based on the results of a search for charging stations, this method retrieves the full/updated information about a single charging station only.

Parameters:

Name Type Description Default
station_id str

station_id is an attribute of the evStation element with a unique value.

 required
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
async def async_get_station_details(self, station_id: str, maxresults: int = 50, offset: int = 0) -> EVChargingStationsResponse | None:
    """
    Retrieve the full/updated information about a single charging station only.

    Based on the results of a search for charging stations, this method
    retrieves the full/updated information about a single charging station only.

    Args:
      station_id (str):
        station_id is an attribute of the evStation element with a unique value.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    data = {"apiKey": self._api_key, "maxresults": maxresults, "offset": offset}
    url = self._base_url + "stations/" + station_id + ".json"
    response = await self.__get_async(url, data, EVChargingStationsResponse)
    return response

async_get_stations_bounding_box(top_left, bottom_right, connectortypes=None, maxresults=50, offset=0) async

Search for charging stations in a bounding box.

The bounding box can have a maximum height or width of 400 km.

Parameters:

Name Type Description Default
top_left List

List contains latitude and longitude in order.

 required
bottom_right List

List contains latitude and longitude in order.

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
async def async_get_stations_bounding_box(
    self,
    top_left: list[float],
    bottom_right: list[float],
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Search for charging stations in a bounding box.

    The bounding box can have a maximum height or width of 400 km.

    Args:
      top_left (List):
        List contains latitude and longitude in order.
      bottom_right (List):
        List contains latitude and longitude in order.
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "bbox": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "bbox": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

Make a search request for charging stations.

A circular search area defined by the latitude and longitude of its center (compliant with WGS 84) and an integer representing the radius of the area in meters, all separated by commas.

Parameters:

Name Type Description Default
latitude float

latitude.

 required
longitude float

longitude.

 required
radius int

Radius of circular area in meter. Radius can be a maximum of 200 km (200000).

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
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
async def async_get_stations_circular_search(
    self,
    latitude: float,
    longitude: float,
    radius: int,
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Make a search request for charging stations.

    A circular search area defined by the latitude and longitude of its center
    (compliant with WGS 84) and an integer representing the radius of the area
    in meters, all separated by commas.

    Args:
      latitude (float):
        latitude.
      longitude (float):
        longitude.
      radius (int):
        Radius of circular area in meter. Radius can be a maximum of 200 km (200000).
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

async_get_stations_corridor(points, connectortypes=None, maxresults=50, offset=0) async

Search for charging stations along a corridor.

The maximum corridor area is 5000 km2.

Parameters:

Name Type Description Default
points List

List contains latitude and longitude pairs in order.

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
async def async_get_stations_corridor(
    self,
    points: list[float],
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Search for charging stations along a corridor.

    The maximum corridor area is 5000 km2.

    Args:
      points (List):
        List contains latitude and longitude pairs in order.
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "corridor": self.__corridor_str(points),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "corridor": self.__corridor_str(points),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = await self.__get_async(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

get_station_details(station_id, maxresults=50, offset=0)

Retrieve the full/updated information about a single charging station only.

Based on the results of a search for charging stations, this method retrieves the full/updated information about a single charging station only.

Parameters:

Name Type Description Default
station_id str

station_id is an attribute of the evStation element with a unique value.

 required
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
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
def get_station_details(self, station_id: str, maxresults: int = 50, offset: int = 0) -> EVChargingStationsResponse | None:
    """
    Retrieve the full/updated information about a single charging station only.

    Based on the results of a search for charging stations, this method
    retrieves the full/updated information about a single charging station only.

    Args:
      station_id (str):
        station_id is an attribute of the evStation element with a unique value.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    data = {"apiKey": self._api_key, "maxresults": maxresults, "offset": offset}
    url = self._base_url + "stations/" + station_id + ".json"
    response = self.__get(url, data, EVChargingStationsResponse)
    return response

get_stations_bounding_box(top_left, bottom_right, connectortypes=None, maxresults=50, offset=0)

Search for charging stations in a bounding box.

The bounding box can have a maximum height or width of 400 km.

Parameters:

Name Type Description Default
top_left List

List contains latitude and longitude in order.

 required
bottom_right List

List contains latitude and longitude in order.

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
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
def get_stations_bounding_box(
    self,
    top_left: list[float],
    bottom_right: list[float],
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Search for charging stations in a bounding box.

    The bounding box can have a maximum height or width of 400 km.

    Args:
      top_left (List):
        List contains latitude and longitude in order.
      bottom_right (List):
        List contains latitude and longitude in order.
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "bbox": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "bbox": str.format(
                "{0},{1};{2},{3}",
                top_left[0],
                top_left[1],
                bottom_right[0],
                bottom_right[1],
            ),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

Make a search request for charging stations.

A circular search area defined by the latitude and longitude of its center (compliant with WGS 84) and an integer representing the radius of the area in meters, all separated by commas.

Parameters:

Name Type Description Default
latitude float

latitude.

 required
longitude float

longitude.

 required
radius int

Radius of circular area in meter. Radius can be a maximum of 200 km (200000).

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
 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
def get_stations_circular_search(
    self,
    latitude: float,
    longitude: float,
    radius: int,
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Make a search request for charging stations.

    A circular search area defined by the latitude and longitude of its center
    (compliant with WGS 84) and an integer representing the radius of the area
    in meters, all separated by commas.

    Args:
      latitude (float):
        latitude.
      longitude (float):
        longitude.
      radius (int):
        Radius of circular area in meter. Radius can be a maximum of 200 km (200000).
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "prox": str.format("{0},{1},{2}", latitude, longitude, radius),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

get_stations_corridor(points, connectortypes=None, maxresults=50, offset=0)

Search for charging stations along a corridor.

The maximum corridor area is 5000 km2.

Parameters:

Name Type Description Default
points List

List contains latitude and longitude pairs in order.

 required
connectortypes List[EVStationConnectorTypes]

Optional, to identify the connector types.

 None
maxresults int

The maximum number of results a response can contain. This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.

 50
offset int

A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

 0

Returns:

Type Description
EVChargingStationsResponse | None

EVChargingStationsResponse

Raises: HEREError

Source code in src/herepy/ev_charging_stations_api.py 
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
def get_stations_corridor(
    self,
    points: list[float],
    connectortypes: list[EVStationConnectorTypes] = None,
    maxresults: int = 50,
    offset: int = 0,
) -> EVChargingStationsResponse | None:
    """
    Search for charging stations along a corridor.

    The maximum corridor area is 5000 km2.

    Args:
      points (List):
        List contains latitude and longitude pairs in order.
      connectortypes (List[EVStationConnectorTypes]):
        Optional, to identify the connector types.
      maxresults (int):
        The maximum number of results a response can contain.
        This parameter can be used with the offset parameter in the query and HasMore in the response for pagination.
      offset (int):
        A value specifying the index of the first result. The offset together with the
        "maxresults" value can be used to support a paging mechanism on search results.
        This parameter can be used with the maxresults parameter in the query and HasMore in the response for pagination.

    Returns:
      EVChargingStationsResponse
    Raises:
      HEREError

    """
    if connectortypes:
        connector_types_str = self.__connector_types_str(connectortypes)
        data = {
            "apiKey": self._api_key,
            "corridor": self.__corridor_str(points),
            "connectortype": connector_types_str,
            "maxresults": maxresults,
            "offset": offset,
        }
    else:
        data = {
            "apiKey": self._api_key,
            "corridor": self.__corridor_str(points),
            "maxresults": maxresults,
            "offset": offset,
        }
    response = self.__get(self._base_url + "stations.json", data, EVChargingStationsResponse)
    return response

UnauthorizedError

Bases: HEREError

Unauthorized Error Type.

This error is returned if the specified token was invalid or no contract could be found for this token.

Source code in src/herepy/ev_charging_stations_api.py 
473
474
475
476
477
478
479
class UnauthorizedError(HEREError):
    """
    Unauthorized Error Type.

    This error is returned if the specified token was invalid or no contract
    could be found for this token.
    """

error_from_ev_charging_service_error(json_data)

Return the correct subclass for ev charging errors.

Source code in src/herepy/ev_charging_stations_api.py 
483
484
485
486
487
488
489
490
491
492
493
494
def error_from_ev_charging_service_error(json_data: dict):
    """Return the correct subclass for ev charging errors."""
    if "Type" in json_data:
        error_type = json_data["Type"]
        message = json_data["Message"]

        if error_type == "Unauthorized":
            return UnauthorizedError(message)
    elif "error" in json_data and "error_description" in json_data:
        return HEREError("Error occurred: " + json_data["error"] + ", description: " + json_data["error_description"])
    # pylint: disable=W0212
    return HEREError("Error occurred on " + sys._getframe(1).f_code.co_name)