Sorry, you need to enable JavaScript to visit this website.

EV Charging Stations Availability

 

Service version: 2
Last edit: 2019.07.09

On this page

Purpose

The EV Charging Stations Availability endpoint provides information about the current availability of charging spots.

Request data

HTTPS method: GET

URL format

For ease of viewing and identification:

  • Constants and parameters enclosed in angle brackets (< >) must be replaced with their values.
  • See the following Request parameters section with the Required and Optional parameters tables for these values.
https://<baseURL>/search/<versionNumber>/chargingAvailability.<ext>?key=<Your_API_Key>&chargingAvailability=<chargingAvailabilityId>

curl command format

curl 'https://<baseURL>/search/<versionNumber>/chargingAvailability.<ext>?key=<Your_API_Key>&chargingAvailability=<chargingAvailabilityId>'

Request parameters

The following table describes the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Parameters and values are case-sensitive.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
Required parameters
Parameter Description
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
The service version.
Value: The current value is 2.
ext
string
The Response format of the API Request. The valid Response format is JSON or XML.
Value: .json or .xml
key
string
An API Key valid for the requested service.
Value: Your valid API Key.
chargingAvailability
string
The chargingAvailability ID, previously retrieved from a Search Request.
Value: Example: 00112233-4455-6677-8899-aabbccddeeff
Optional parameters
Note: There are no optional parameters in this endpoint.

▲ Return to top

Response data

Response body

If the <ext> parameter value is set to .json, the Response will be a JSON object with the following structure:

{
  "connectors": [
    {
      "type": "IEC62196Type2Outlet",
      "total": 2,
      "availability": {
        "current": {
          "available": 1,
          "occupied": 1,
          "reserved": 0,
          "unknown": 0,
          "outOfService": 0
        }
      }
    }
  ],
  "chargingAvailability": "75502858-a491-36fe-7128-23d400153b86"
}

If the <ext> parameter value is set to .xml, the Response will be a XML format with the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <chargingAvailability>75502858-a491-36fe-7128-23d400153b86</chargingAvailability>
   <connectors>
      <item>
         <type>IEC62196Type2Outlet</type>
         <total>2</total>
         <availability>
            <current>
               <available>1</available>
               <occupied>1</occupied>
               <reserved>0</reserved>
               <unknown>0</unknown>
               <outOfService>0</outOfService>
            </current>
         </availability>
      </item>
   </connectors>
</response>

Usage and Freshness of EV Charging Stations Availability data

Updates are provided regularly, typically within minutes.

Response fields

The following table describes all of the fields that can appear in a Response. Fields are listed by the Response section they belong to and in the order that they appear in the Response.

Response
Field Description
chargingAvailability
string
The ID of the returned entity.
connectors
array
The charging connector data.
Connectors
Field Description
type
string
The charging connector type.
total
integer
The total number of charging spots of the type type in chargingAvailability.
availability
object
The current availability data for this connector type.
Availability.Current
Field Description
current
object
Contains the current availability data.
available
integer
The number of charging spots that are available.
occupied
integer
The number of charging spots that are occupied.
reserved
integer
The number of charging spots that are reserved.
unknown
integer
The number of charging spots whose availability data is not known.
outOfService
integer
The number of charging spots that are out of service.

HTTP Response codes

Code Meaning and Possible Causes
200 OK: If the given chargingAvailability was found, the body of the Response will contain the data. Otherwise, the Response will contain an empty connectors array in the Response body. For example:

{
  "connectors":[],
  "chargingAvailability":"1"
}
400 Bad request: One or more parameters (e.g., chargingAvailability, ext) were incorrectly specified or are out of range.
403 Permission, capacity, or authentication issues:

  • Forbidden
  • Not authorized
  • Account inactive
  • Account over queries per second limit
  • Account over rate limit
  • Rate limit exceeded
404 Not Found: The requested resource could not be found, but it may be available again in the future.
405 Method Not Allowed: The client used a HTTP method other than GET.
408 The Request has timed out.
414 The requested URI is too long.
500 An error occurred while processing the Request. Please try again later.
502 Internal network connectivity issue.
503 Service currently unavailable.
504 An internal network connectivity issue, or a Request that has taken too long to complete.
596 Service not found.

Response headers

The following table lists HTTP Response headers of particular interest to EV Charging Stations Availability service clients.

Header Description
Access-Control-Allow-Origin The Charging Availability service allows cross-origin resource sharing.
Value: * This asterisk signifies access to the TomTom API using the Access-Control-Allow-Origin (ACAO) header in its Response, indicating which origin sites are allowed.
Content-Encoding The Charging Availability service supports HTTP compression if requested by the client.
Value: gzip
Cache-Control The Cache-Control general-header field is used to specify directives that must be obeyed by all caching mechanisms along the Request/Response chain.

  • Supported by HTTP/1.1 clients.
  • May not be supported by HTTP/1.0 clients.

Value: no-cache

Content-Type Indicates the format of the Response as chosen by the client. Format: type/subtype; charset=utf-8
Value: type/subtype: application/json

▲ Return to top

You are here