Documentation

EV Service API

The EV Service API provides information about charging stations and the current availability of charging points. There are two types of information feeds: static and dynamic. Both types of feeds are available in every country where we offer service. Customers can provide their clients with updated availability information for all nearby charging stations.

The Static Feed

The static feed provides comprehensive information that does not change rapidly; it is supposed to be downloaded a few times per day to pick up the latest changes. The feed has a hierarchical structure of the following elements:

Charging park - may include a group of one or more charging stations.
Charging station - may include one or more charging points. Each charging station often corresponds to a single "pole" that provides one or more charging points.
Charging point - Each charging point provides point location and a plug type.

The charging park holds shared properties of the grouped charging stations like operator, address, location, opening hours, etc.

Element Type	Description
Charging park	charging stations who are close to each other can be grouped into a charging park.
Charging station	Often corresponds to a single "pole". One station often has more than one charging point.
Charging point	Corresponds to a EVSE. This can be thought of as the charging facility capable of accomodating one car.

Charging parks, stations and points have two IDs associated with them. * Uuid is a globally unique ID. It uniquely identifies an entity. The uuid is used as reference in the dynamic feed. * ExternalId is an ID used by external providers. In the case of charging points for certain providers this may be the EVSE ID. The external ID may not uniquely identify an entity in this feed.

The Dynamic Feed

The dynamic feed provides frequently updated information of the current availability for different types of charging points for each station, referenced by the unique per-station-ID provided in the static feed and a unique charging point ID.

Element Type	Description
Charging station update	References a charging station by a uuid and includes updated charging points.
Charging point update	References a charging point.

Request

Format

https://<baseURL>/electromobility/<version>/<feedType>/<countryCode>?key=<apiKey>

Example

The static feed for Germany

https://api.tomtom.com/electromobility/v1/static/de?key=<apiKey>

The dynamic feed for Germany

https://api.tomtom.com/electromobility/v1/dynamic/de?key=<apiKey>

Parameters

Parameter	Description	Required	Example	Default
baseURL	Base URL for calling TomTom services.	Yes	api.tomtom.com	-
version	The version of the service to call.	Yes	v1	-
feedType	The type of information requested: static - Static information about all stations in the country, such as name, location, and opening hours. dynamic - Dynamic information about the current availability for all stations in the country.	Yes	static dynamic	-
countryCode	The ISO 3166-1 alpha-2 code of the country of interest in lowercase letters. See the Country Coverage for supported countries.	Yes	de	-
apiKey	Authorization key for access to the API.	Yes	-	-

Headers

Header	Description	Required	Example	Default
[Accept-Encoding]	Requests that the response is compressed in the specified way. The service supports http compression if desired. Currently, gzip is supported.	No	gzip	-
[If-None-Match]	Provides the entity-tag (E-tag) of the requested resource as last received by the client. Allows efficient updates of cached information with a minimum amount of transaction overhead: The service can respond with a 304 (not modified) message if the data that would otherwise be provided has the same entity tag.	No	"4f3d2af4"	-
[If-Modified-Since]	Specifies the time stamp of the last actual update of the requested resource received by the client. Allows the service to respond with a 304 (not modified) message if no newer data is available.	No	Sat, 29 Oct 1994 19:43:31 GMT	-

Request Content

Plain GET messages are to be used to create requests for both the static and the dynamic feed.

Response

Response Codes

Code	Meaning and possible causes
200	OK
304	Not Modified: The requested content did not change since the last request, as indicated by the value(s) of the If-Modified-Since and/or or If-None-Match http header fields.
401	Unauthorized: The supplied API key is not valid for this request (or missing)
404	Not Found: The specified path was not valid. At least one of the path parameters was omitted or not entered correctly. If an unsupported or invalid country code was specified, the included response message provides a list of valid available country codes.
500	Internal Server Error: Oops.

Response Headers

Header	Description	Values
Content-Encoding	The service supports http compression if desired. Currently, gzip is supported.	gzip
Content-Type	The format of the served resource. The service always provides data in xml.	application/xml
Date	A timestamp specifying when the response was sent. Can be used by the client in the If-Modified-Since header field of subsequent requests in order to optimize the update procedure.	Example: "Wed, 20 Jul 2016 14:23:59 GMT"
Etag	Entity-tag of the served resource. Can be used by the client in the If-None-Match header field of subsequent requests in order to optimize the update procedure.	Example: "4f3d2af4"

Static Feed

Example Response

The available static information for all known charging stations in the requested country is provided as xml. The order of the stations is not specified.

<?xml version="1.0" encoding="UTF-8" ?>
<chargingParks xmlns="http://www.tomtom.com/service/tis/chargingstation/static/1.0"
               xmlns:meta="http://www.tomtom.com/service/tis/chargingstation/metadata/1.0"
               xmlns:p="http://www.tomtom.com/service/tis/primitives/1.0"
               xmlns:lb="http://www.tomtom.com/service/tis/locBbox"
               xmlns:lp="http://www.tomtom.com/service/tis/location/point/1.0"
               xmlns:la="http://www.tomtom.com/service/tis/location/address/1.0"
               xmlns:lh="http://www.tomtom.com/service/tis/location/hash/1.0"
               xmlns:oh="http://www.tomtom.com/service/tis/openinghours/1.0"
               schemaVersion="1.0">

    <meta:metaData>
        <meta:creatorVersion>0.01-9.1.RC2@0</meta:creatorVersion>
        <meta:creatorUUID>1232abdf-6ef7-4310-81b5-e7e4be3786f0</meta:creatorUUID>
        <meta:creationTimeUTC>2016-01-13T09:06:46Z</meta:creationTimeUTC>
        <meta:description>Example showing static charging station information</meta:description>
    </meta:metaData>

    <chargingPark>
        <uuid>9876dcba-5f0e-2314-435a-aa34cd12f9fe</uuid>

        <properties>
            <name>Baker Motor</name>
            <accessibilityType>public</accessibilityType>
            <countryCode>DE</countryCode>
            <contact>
                <email>aEmail@address.com</email>
                <web>http://tomtom.com</web>
                <phone>+49 228 123231</phone>
                <fax>+49 228 123232</fax>
            </contact>
            <operator>
                <name>operator's name</name>
                <contact>
                    <email>operatorEmail@address.com</email>
                    <web>http://tomtom.com/operator</web>
                    <phone>+49 228 223231</phone>
                    <fax>+49 228 223232</fax>
                </contact>
                <address>
                    <la:street>An den Treptowers 1</la:street>
                    <la:city>Berlin</la:city>
                    <la:postalCode>5455</la:postalCode>
                    <la:country>DE</la:country>
                </address>
            </operator>
            <oh:openingHours>
                <oh:openingPeriod>
                    <oh:day>
                        <oh:from>Mo</oh:from>
                        <oh:to>Fr</oh:to>
                    </oh:day>
                    <oh:time>
                        <oh:opens>00:00</oh:opens>
                    </oh:time>
                </oh:openingPeriod>
                <oh:openingPeriod>
                    <oh:day>
                        <oh:from>Sa</oh:from>
                        <oh:to>So</oh:to>
                    </oh:day>
                    <oh:time>
                        <oh:opens>06:30</oh:opens>
                        <oh:closes>10:00</oh:closes>
                    </oh:time>
                </oh:openingPeriod>
            </oh:openingHours>
        </properties>

        <locations>
            <lb:boundingBox>
                <lb:lowerLeft>
                    <p:latitude>50.73689</p:latitude>
                    <p:longitude>7.10662</p:longitude>
                </lb:lowerLeft>
                <lb:upperRight>
                    <p:latitude>50.73698</p:latitude>
                    <p:longitude>7.10674</p:longitude>
                </lb:upperRight>
            </lb:boundingBox>
            <lp:pointLocation>
                <p:latitude>50.73689</p:latitude>
                <p:longitude>7.10674</p:longitude>
            </lp:pointLocation>
            <lh:locationHash>7230324</lh:locationHash>
        </locations>

        <chargingStations>
            <chargingStation>
                <uuid>1232abdf-6ef7-4310-81b5-e7e4be3786f0</uuid>
                <externalId>anExternalId-A</externalId>
                <name>First station</name>
                <payment>
                        <method>Subscription</method>
                </payment>
                <locations>
                    <lb:boundingBox>
                        <lb:lowerLeft>
                            <p:latitude>50.73689</p:latitude>
                            <p:longitude>7.10662</p:longitude>
                        </lb:lowerLeft>
                        <lb:upperRight>
                            <p:latitude>50.73698</p:latitude>
                            <p:longitude>7.10674</p:longitude>
                        </lb:upperRight>
                    </lb:boundingBox>
                    <lp:pointLocation>
                        <p:latitude>50.73689</p:latitude>
                        <p:longitude>7.10674</p:longitude>
                    </lp:pointLocation>
                    <lh:locationHash>6138943</lh:locationHash>
                </locations>
                <chargingPoints>
               <chargingPoint>
                        <uuid>5e332e95-b0bc-3f35-0000-00090af7026d</uuid>
                        <externalId>anExternalId-A_1a</externalId>
                        <name>First point</name>
                        <plugType>DC Charging >50kW</plugType>
                        <locations>
                            <lp:pointLocation>
                                <p:latitude>50.73689</p:latitude>
                                <p:longitude>7.10676</p:longitude>
                            </lp:pointLocation>
                        </locations>
                    </chargingPoint>
                    <chargingPoint>
                        <uuid>7260f725-04ea-38a4-0000-00090af7026d</uuid>
                        <externalId>anExternalId-A_1b</externalId>
                        <name>Second point</name>
                        <plugType>380 - 480V, 3-Phase ≤63A</plugType>
                    </chargingPoint>
                    <chargingPoint>
                        <uuid>2823a471-1d57-311f-0000-00090af7026d</uuid>
                        <externalId>anExternalId-A_2a</externalId>
                        <name>Third point</name>
                        <plugType>Tesla</plugType>
                        <locations>
                            <lp:pointLocation>
                                <p:latitude>50.73689</p:latitude>
                                <p:longitude>7.10678</p:longitude>
                            </lp:pointLocation>
                        </locations>
                    </chargingPoint>
                </chargingPoints>
            </chargingStation>
            <!-- Can contain more -->
        </chargingStations>
    </chargingPark>
</chargingParks>

Usage and Freshness

By nature of this static feed, there is infrequent changes in the provided content. It is reasonable to expect update requests of approximately once per day. Using the support for If-None-Match or If-Modified-Since header fields, update request frequencies higher than once per day could be used to minimize the delay between updated information being available on the server and being received by the client.

Dynamic Feed

Example Response

The Dynamic Feed provides information for all known charging points in the requested country, referenced by UUID. The order of the stations is not specified.

<?xml version="1.0" encoding="UTF-8"?>
<chargingParksDynamic xmlns="http://www.tomtom.com/service/tis/chargingstation/dynamic/1.0"
                      xmlns:meta="http://www.tomtom.com/service/tis/chargingstation/metadata/1.0"
                      schemaVersion="1.0">

    <meta:metaData>
        <meta:creatorVersion>0.01-9.1.RC2@0</meta:creatorVersion>
        <meta:creatorUUID>1232abdf-6ef7-4310-81b5-e7e4be3786f0</meta:creatorUUID>
        <meta:creationTimeUTC>2016-01-13T09:06:46Z</meta:creationTimeUTC>
        <meta:description>Example showing dynamic charging station information</meta:description>
    </meta:metaData>

    <chargingStationUpdate>
        <referenceUuid>798c93fc-ba74-102b-b5ef-00304891a58c</referenceUuid>
        <chargingPointUpdates>
            <chargingPointUpdate>
                <referenceUuid>7260f725-04ea-38a4-0000-00090af7026d</referenceUuid>
                <status>available</status>
            </chargingPointUpdate>
            <chargingPointUpdate>
                <referenceUuid>2823a471-1d57-311f-0000-00090af7026d</referenceUuid>
                <status>occupied</status>
            </chargingPointUpdate>
        </chargingPointUpdates>
        <!-- Can contain more -->
    </chargingStationUpdate>

</chargingParksDynamic>

Usage and Freshness

Updates are provided regularly; typically at a rate of once per minute. Using the support for If-None-Match or If-Modified-Since header fields, any update request frequencies higher than once-per-minute can be used to minimize the delay between updated information being available in the server and being received by the client.