EV Search Along the Route

Service version: 2

Last edit: 2025.06.03

TomTom Maps

Important note This EV Search API is unavailable on a Freemium or Pay As You Grow (PAYG) basis. Click the Request Access button above to contact our Sales team.

Purpose

The EV Search Along the Route endpoint provides information about the EV POIs along a pre-calculated route. By providing optional request parameters, the API allows filtering of the response by connector type, availability status, etc. This feature is particularly useful for long-distance travel where the vehicle may need to be charged one or more times to complete the journey.

If the detour request parameter is set to true, the search response will include detour information (if calculable), which consists of:

Detour distance: The difference between the distances of the original route and the recalculated route going through the EV POI (as way-point).
Detour time: The additional time required to take the detour.
Detour offset: The distance between the start of the original route and the starting point of the detour to the POI.

Please note that with detour, the original route may be altered, and some of its points may be skipped. If the route that passes through the POI is faster than the original one, the detour distance/time value would be negative.

Request data

HTTPS method: `POST`

For ease of viewing and identification:

Constants and parameters enclosed in curly brackets { } must be replaced with their values.
Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

Request format

get

Request URL format

https://{baseURL}/search/{versionNumber}/alongRoute?key={Your_API_Key}[optional parameters]

get
Request body format
1Content-Type: application/json
2
3{
4  "route": {
5    "coordinates": [
6      [longitude1, latitude1],[longitude2, latitude2],...
7    ],
8    "type":"LineString"
9  },
10  "width": integer
11}

Request curl command example

post
Request curl command example
1curl --location "https://api.tomtom.com/search/2/alongRoute?key={Your_API_Key}&status=Available,Unknown&connector=IEC62196Type2Outlet&accessType=Public&restriction=evOnly&capability=ChargingProfileCapable&minPowerKW=22.2&maxPowerKW=150.0&limit=20&view=Unified" \
2--header 'Content-Type: application/json' \
3--data '{
4  "route": {
5    "coordinates": [
6      [4.90415,52.36759],[4.90393,52.36774],[4.90386,52.36775],
7      [4.90355,52.36793],[4.90350,52.36796],[4.90344,52.36799],
8      [4.90342,52.36799],[4.90336,52.36800],[4.90332,52.36800],
9      [4.90327,52.36800],[4.90310,52.36796],[4.90299,52.36793]
10    ],
11    "type":"LineString"
12  },
13  "width":1000
14}'

Request body

The endpoint requires a request body in application/json format which includes the route and width of the route, within which the search will be conducted.

Request body	Description
`width` integer	Search distance from the the route in meters. The default value is 500 meters. Default: `500`
`route` object	The route to search along. Value: A valid GeoJSON LineString geometry. Please refer to RFC 7946 for details.

route object
Field	Description
`type` string	The type of the GeoJSON object. Current supported value is `LineString`.
`coordinates` array	Array of coordinates in the form of `[longitude, latitude]`

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.

Required parameters Description

Required parameters	Description
`baseURL` string	Base URL for calling the API. Values: `api.tomtom.com` `kr-api.tomtom.com` (see the Region-specific content page)
`versionNumber` string	The service version. Value: The current value is `2`.
`key` string	An API Key valid for the requested service. Value: Your valid `API Key`.

baseURL string

Base URL for calling the API.
Values:

api.tomtom.com
kr-api.tomtom.com (see the Region-specific content page)

versionNumber string

The service version.
Value: The current value is 2.

key string

An API Key valid for the requested service.
Value: Your valid API Key.

Optional parameters	Description
`detour` boolean	This parameter enables the enrichment of search results with detour information. Note: When querying with `detour=true`, the maximum number of results specified by `limit`, is capped at 20. Default: `false`
`limit` integer	Maximum number of search results that will be returned. Value: An integer value between 1 and 100. Note: The maximum number of results returned when the `detour` parameter is set to `true` is limited to 20. Default: `10`
`status` string	The comma-separated status values of charging points to be filtered. Enum: Available Reserved Occupied OutOfService Unknown
`connector` string	A comma-separated list of connector types which could be used to restrict the result to specific connector types. See the list of Supported Connector Types. Value: A comma-separated list of connector types (in any order). Example: `IEC62196Type2Outlet,IEC62196Type2CableAttached`
`accessType` string	The comma-separated access types, which could be used to restrict the results to EV POIs with specific access types. Enum: Public Authorized Restricted Private Unknown
`restriction` string	The comma-separated restrictions, which could be used to restrict the results to EV POIs with specific restrictions. Enum: evOnly plugged disabled customers motorcycles
`capability` string	The comma-separated capabilities, which could be used to restrict the results to EV POIs with specific capabilities. Enum: ChargingProfileCapable ChargingPreferencesCapable ChipCardSupport ContactlessCardSupport CreditCardPayable DebitCardPayable PedTerminal RemoteStartStopCapable Reservable RfidReader StartSessionConnectorRequired TokenGroupCapable UnlockCapable PlugAndCharge
`minPowerKW` double	An optional parameter that could be used to restrict the result to charging stations with connectors having a specific minimal value of power in kilowatts (closed interval - with that value). Value: A double value representing the power rate in kilowatts. Example: `22.2` This parameter might be used together with `[maxPowerKW]`.
`maxPowerKW` double	An optional parameter that could be used to restrict the result to charging stations with connectors having a specific maximum value of power in kilowatts (closed interval - with that value). Value: A double value representing the power rate in kilowatts. Example: `43.2` This parameter might be used together with `[minPowerKW]`.
`vehicleType` string	The comma-separated vehicle types, which could be used to restrict the results to charging stations where specific vehicle types can be charged. Enum: Car Truck This parameter might be used together with `[vehicleCategory]`. Value: The comma-separated list of vehicle types (in any order). Example: `Car,Truck`
`vehicleCategory` string	The comma-separated vehicle categories, which could be used to restrict the results to charging stations where specific categories of vehicles can be charged. Enum: N1 N2 N3 N3+O4 This parameter might be used together with `[vehicleType]`. Value: The comma-separated list of vehicle categories (in any order). Note: Parameter value is expected to be URL Encoded. Example: `N2,N3%2BO4`
`vehicleHeight` double	An optional parameter that could be used to restrict the results to charging stations where vehicles of a height in meters can be charged. Value: Positive double value representing vehicle height in meters. Example: `2.6`
`vehicleWidth` double	An optional parameter that could be used to restrict the results to charging stations where vehicles of a width in meters can be charged. Value: Positive double value representing vehicle width in meters. Example: `1.8`
`vehicleLength` double	An optional parameter that could be used to restrict the results to charging stations where vehicles of a length in meters can be charged. Value: Positive double value representing vehicle length in meters. Example: `16.5`
`vehicleWeight` integer	An optional parameter that could be used to restrict the results to charging stations where vehicles of a weight in kilograms can be charged. Value: Positive double value representing vehicle weight in kilograms. Example: `12500`
`vehicleBrand` string	An optional parameter that could be used to restrict the results to charging stations where given vehicle brand is allowed to charge. Value: Vehicle brand name. Example: `Tesla`
`view` string	Geopolitical View. The context used to resolve the handling of disputed territories. Enum: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `TR`, `CN`, `TW` Default values: Argentina, default view: `AR`, available views: `Unified`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `TR`, `CN`, `TW` India, default view: `IN`, available views: - Morocco, default view: `MA`, available views: `Unified`, `AR`, `IL`, `IN`, `PK`, `RS`, `RU`, `TR`, `CN`, `TW` Pakistan, default view: `PK`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `RS`, `RU` , `TR`, `CN`, `TW` Serbia, default view: `RS`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RU`, `TR`, `CN`, `TW` Russia, default view: `RU`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `TR`, `CN`, `TW` Turkey, default view: `TR`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `CN`, `TW` China, default view: `CN`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `TR`, `TW` Taiwan, default view: `TW`, available views: `Unified`, `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `TR`, `CN` Others, default view: `Unified`, available views: `AR`, `IL`, `IN`, `MA`, `PK`, `RS`, `RU`, `TR`, `CN`, `TW`
`nearby` string	The comma-separated IDs of nearby Points of Interest (POIs) categories can be used to limit the results of charging stations. Nearby POIs are points of interest within walking distance of the charging stations that users can explore while charging their vehicles. Enum: 7315 - Restaurant 9932 - Public Amenity 9376 - Café/Pub 7314 - Hotel/Motel 9361 - Shop 9362 - Park Recreation Area Example: `nearby=[7315,9362]`
`brand` string	The comma separated brand values of EV POI to be filtered. The brand value can be either the brand name or the brand id. Example: `brand=TotalEnergies,ALZFFQCR,Allego`
`paymentBrand` string	Enum: "F2M Charge" "Plugsurfing" "Vattenfall InCharge - Incharge" "Vandebron" "Maserati Charge" "FISKER FLEX" "MyEasyCharge" "Nissan Energy" "Eneco" "eSolutions Charging" "EVBox Charge" "Shell Recharge" "FrCS" Example: paymentBrand=Plugsurfing,MyEasyCharge The comma separated payment brands, which could be used to limit the results of the charging stations. The value for payment brand can be either the name or the id of that brand.

Request headers

The following table describes the HTTP request headers.

Optional headers	Description
Tracking-ID	Specifies an identifier for the request. It can be used to trace a call. The value must match the regular expression `'^[a-zA-Z0-9-]{1,100}$'`. An example of the format that matches this regular expression is UUID (e.g., `9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1`). For details check RFC 4122. If specified, it is replicated in the Tracking-ID response header. It is only meant to be used for support and does not involve tracking of you or your users in any form. Value: An `identifier` for the request.
Accept	Specifies one of the following values as the response format of an API request: `application/json` Default if the header is not provided. `application/xml`
Accept-Language	Should be one of the TomTom supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field or the language is not specified, the NGT (NeutralGroundTruth) of the POI will be used.
JMESPath	This header can be used to execute a JMESPath query on the API response. For more information refer to JMESPath examples. Default value: If no header is provided, all response fields are included. Note: The header value has to be URL encoded. Example: `results[*].{id:id,position:position}` will only return the id and position fields of the results.
Sorting-Preset	This header is used to pass a sorting preset to the EV Search API. Preset can be any of the following: Major: Major POIs (criteria like size, speed and popularity -in the future- will be used together with the user preferences) NearBy: NearBy POIs (only beeline distance will be considered together with the user preferences) MajorNearby: Major and NearBy POIs (combination of the first two presets) re-ranked by beeline distance Detour: Major POIs re-ranked based on detour information If no sorting header is specified, a default sorting behavior up to the API's discretion is applied.

Response data

Response body

If the Accept header value is set to application/json, the response will be a JSON object with the following structure:

Json response body example
1{
  "summary": {
      "numResults": 2,
      "totalResults": 191
  },
  "results": [
      {
          "id": "939d44d0-cf00-42e9-b9f3-bf4d2de125b5",
          "name": "TotalEnergies",
          "position": {
              "lat": 52.364941,
              "lon": 4.8935986
          },
          "chargingStations": [
              {
                  "id": "e0bead1c-6884-11ee-9f49-42010aa40fc0",
                  "chargingPoints": [
                      {
                          "capabilities": [
                              "CreditCardPayable",
                              "RemoteStartStopCapable",
                              "RfidReader"
                          ],
                          "connectors": [
                              {
                                  "id": "1",
                                  "currentA": 25,
                                  "currentType": "AC3",
                                  "ratedPowerKW": 17.0,
                                  "type": "IEC62196Type2Outlet",
                                  "voltageV": 230
                              }
                          ],
                          "evseId": "NL-GFX-ETNLP011512-1",
                          "physicalReference": "TNLP011512",
                          "status": "Available"
                      },
                      {
                          "capabilities": [
                              "CreditCardPayable",
                              "RemoteStartStopCapable",
                              "RfidReader"
                          ],
                          "connectors": [
                              {
                                  "id": "2",
                                  "currentA": 25,
                                  "currentType": "AC3",
                                  "ratedPowerKW": 17.0,
                                  "type": "IEC62196Type2Outlet",
                                  "voltageV": 230
                              }
                          ],
                          "evseId": "NL-GFX-ETNLP011512-2",
                          "physicalReference": "TNLP011512",
                          "status": "Occupied"
                      }
                  ]
              }
          ],
          "address": {
              "countryCode": "NL",
              "countryCodeISO3": "NLD",
              "country": "Netherlands",
              "countrySubdivision": "North Holland",
              "countrySubdivisionName": "North Holland",
              "countrySubdivisionCode": "NH",
              "freeformAddress": "Oudezijds Voorburgwal 99F, 1012 EM Amsterdam",
              "localName": "Amsterdam",
              "municipality": "Amsterdam",
              "postalCode": "1012 EM",
              "streetNumber": "99F",
              "streetName": "Oudezijds Voorburgwal"
          },
          "openingHours": {
              "mode": "nextSevenDays",
              "timeRanges": [
                  {
                      "startTime": {
                          "date": "2024-05-02",
                          "hour": 0,
                          "minute": 0
                      },
                      "endTime": {
                          "date": "2024-05-09",
                          "hour": 0,
                          "minute": 0
                      }
                  }
              ]
          },
          "timeZone": {
              "ianaId": "Europe/Amsterdam"
          },
          "paymentOptions": [
              {
                  "brands": [
                      {
                          "name": "Plugsurfing"
                      },
                      {
                          "name": "Eneco"
                      },
                      {
                          "name": "Vattenfall InCharge - Incharge"
                      },
                      {
                          "name": "EVBox Charge"
                      },
                      {
                          "name": "Shell Recharge"
                      },
                      {
                          "name": "Vandebron"
                      }
                  ]
              }
          ],
          "nearbyPois": [7315,9932],
          "accessType": "Public",
          "vehicleConstraint": {
              "types": ["Car", "Truck"],
              "categories": ["N1", "N2"],
              "length": 5.0,
              "height": 2.75,
              "width": 2.0,
              "weight": 3500,
              "brands": [
                 {
                   "name": "Tesla"
                 },
                 {
                   "name": "Rivian"
                 }
              ]
          }
      },
      {
          "id": "c31bc9fb-8935-4df5-97c6-51acbaccc601",
          "name": "EQUANS",
          "position": {
              "lat": 52.3653884,
              "lon": 4.8922383
          },
          "chargingStations": [
              {
                  "id": "67335c40-4e72-11e8-8f53-42010a840002",
                  "chargingPoints": [
                      {
                          "capabilities": [
                              "RemoteStartStopCapable",
                              "RfidReader"
                          ],
                          "connectors": [
                              {
                                  "id": "1",
                                  "currentA": 16,
                                  "currentType": "AC3",
                                  "ratedPowerKW": 11.0,
                                  "type": "IEC62196Type2Outlet",
                                  "voltageV": 230
                              }
                          ],
                          "evseId": "NL-GFX-EEVB-P1552388-1",
                          "physicalReference": "1552388",
                          "status": "Occupied"
                      },
                      {
                          "capabilities": [
                              "RemoteStartStopCapable",
                              "RfidReader"
                          ],
                          "connectors": [
                              {
                                  "id": "2",
                                  "currentA": 16,
                                  "currentType": "AC3",
                                  "ratedPowerKW": 11.0,
                                  "type": "IEC62196Type2Outlet",
                                  "voltageV": 230
                              }
                          ],
                          "evseId": "NL-GFX-EEVB-P1552388-2",
                          "physicalReference": "1552388",
                          "status": "OutOfService"
                      }
                  ]
              }
          ],
          "address": {
              "countryCode": "NL",
              "countryCodeISO3": "NLD",
              "country": "Netherlands",
              "countrySubdivision": "North Holland",
              "countrySubdivisionName": "North Holland",
              "countrySubdivisionCode": "NH",
              "freeformAddress": "Herengracht 505, 1017 BV Amsterdam",
              "localName": "Amsterdam",
              "municipality": "Amsterdam",
              "postalCode": "1017 BV",
              "streetNumber": "505",
              "streetName": "Herengracht"
          },
          "openingHours": {
              "mode": "nextSevenDays",
              "timeRanges": [
                  {
                      "startTime": {
                          "date": "2024-05-02",
                          "hour": 0,
                          "minute": 0
                      },
                      "endTime": {
                          "date": "2024-05-09",
                          "hour": 0,
                          "minute": 0
                      }
                  }
              ]
          },
          "timeZone": {
              "ianaId": "Europe/Amsterdam"
          },
          "paymentOptions": [
              {
                  "brands": [
                      {
                          "name": "Plugsurfing"
                      },
                      {
                          "name": "Vattenfall InCharge - Incharge"
                      },
                      {
                          "name": "EVBox Charge"
                      },
                      {
                          "name": "Shell Recharge"
                      },
                      {
                          "name": "Vandebron"
                      }
                  ]
              }
          ],
          "nearbyPois": [7315,9932],
          "accessType": "Public",
          "vehicleConstraint": {
              "types": ["Car", "Truck"],
              "categories": ["N1", "N2", "N3", "N3+O4"],
              "length": 15.0,
              "height": 2.75,
              "width": 2.0,
              "weight": 13500,
              "brands": [
                 {
                   "name": "Tesla"
                 },
                 {
                   "name": "Rivian"
                 }
              ]
          }
      }
  ]
265}

If the Accept header value is set to application/xml, the response will be an XML object with the following structure:

XML response body example
1<response>
  <summary>
      <numResults>2</numResults>
      <totalResults>191</totalResults>
  </summary>
  <results>
      <item>
          <id>939d44d0-cf00-42e9-b9f3-bf4d2de125b5</id>
          <name>TotalEnergies</name>
          <position>
              <lat>52.364941</lat>
              <lon>4.8935986</lon>
          </position>
          <address>
              <countryCode>NL</countryCode>
              <countryCodeISO3>NLD</countryCodeISO3>
              <country>Netherlands</country>
              <countrySubdivision>North Holland</countrySubdivision>
              <countrySubdivisionName>North Holland</countrySubdivisionName>
              <countrySubdivisionCode>NH</countrySubdivisionCode>
              <freeformAddress>Oudezijds Voorburgwal 99F, 1012 EM Amsterdam</freeformAddress>
              <localName>Amsterdam</localName>
              <municipality>Amsterdam</municipality>
              <postalCode>1012 EM</postalCode>
              <streetNumber>99F</streetNumber>
              <streetName>Oudezijds Voorburgwal</streetName>
          </address>
          <openingHours>
              <mode>nextSevenDays</mode>
              <timeRanges>
                  <timeRange>
                      <startTime>
                          <date>2024-05-02</date>
                          <hour>0</hour>
                          <minute>0</minute>
                      </startTime>
                      <endTime>
                          <date>2024-05-09</date>
                          <hour>0</hour>
                          <minute>0</minute>
                      </endTime>
                  </timeRange>
              </timeRanges>
          </openingHours>
          <timeZone>
              <ianaId>Europe/Amsterdam</ianaId>
          </timeZone>
          <accessType>Public</accessType>
          <chargingStations>
              <chargingStation>
                  <id>e0bead1c-6884-11ee-9f49-42010aa40fc0</id>
                  <chargingPoints>
                      <chargingPoint>
                          <evseId>NL-GFX-ETNLP011512-1</evseId>
                          <physicalReference>TNLP011512</physicalReference>
                          <status>Available</status>
                          <capabilities>
                              <capability>CreditCardPayable</capability>
                              <capability>RemoteStartStopCapable</capability>
                              <capability>RfidReader</capability>
                          </capabilities>
                          <connectors>
                              <connector>
                                  <id>1</id>
                                  <currentA>25</currentA>
                                  <currentType>AC3</currentType>
                                  <ratedPowerKW>17.0</ratedPowerKW>
                                  <type>IEC62196Type2Outlet</type>
                                  <voltageV>230</voltageV>
                              </connector>
                          </connectors>
                      </chargingPoint>
                      <chargingPoint>
                          <evseId>NL-GFX-ETNLP011512-2</evseId>
                          <physicalReference>TNLP011512</physicalReference>
                          <status>Occupied</status>
                          <capabilities>
                              <capability>CreditCardPayable</capability>
                              <capability>RemoteStartStopCapable</capability>
                              <capability>RfidReader</capability>
                          </capabilities>
                          <connectors>
                              <connector>
                                  <id>2</id>
                                  <currentA>25</currentA>
                                  <currentType>AC3</currentType>
                                  <ratedPowerKW>17.0</ratedPowerKW>
                                  <type>IEC62196Type2Outlet</type>
                                  <voltageV>230</voltageV>
                              </connector>
                          </connectors>
                      </chargingPoint>
                  </chargingPoints>
              </chargingStation>
          </chargingStations>
          <paymentOptions>
              <paymentOption>
                  <brands>
                      <brand>
                          <name>Plugsurfing</name>
                      </brand>
                      <brand>
                          <name>Eneco</name>
                      </brand>
                      <brand>
                          <name>Vattenfall InCharge - Incharge</name>
                      </brand>
                      <brand>
                          <name>EVBox Charge</name>
                      </brand>
                      <brand>
                          <name>Shell Recharge</name>
                      </brand>
                      <brand>
                          <name>Vandebron</name>
                      </brand>
                  </brands>
              </paymentOption>
          </paymentOptions>
          <nearbyPois>
              <nearbyPoi>
                  <categoryId>7315</categoryId>
              </nearbyPoi>
              <nearbyPoi>
                  <categoryId>9932</categoryId>
              </nearbyPoi>
          </nearbyPois>
          <vehicleConstraint>
              <types>
                  <type>Car</type>
                  <type>Truck</type>
              </types>
              <categories>
                  <category>N1</category>
                  <category>N2</category>
              </categories>
              <height>2.75</height>
              <width>2.5</width>
              <length>5.0</length>
              <weight>3500</weight>
              <brands>
                  <brand>
                      <name>Tesla</name>
                  </brand>
                  <brand>
                      <name>Rivian</name>
                  </brand>
              </brands>
          </vehicleConstraint>
      </item>
      <item>
          <id>c31bc9fb-8935-4df5-97c6-51acbaccc601</id>
          <name>EQUANS</name>
          <position>
              <lat>52.3653884</lat>
              <lon>4.8922383</lon>
          </position>
          <address>
              <countryCode>NL</countryCode>
              <countryCodeISO3>NLD</countryCodeISO3>
              <country>Netherlands</country>
              <countrySubdivision>North Holland</countrySubdivision>
              <countrySubdivisionName>North Holland</countrySubdivisionName>
              <countrySubdivisionCode>NH</countrySubdivisionCode>
              <freeformAddress>Herengracht 505, 1017 BV Amsterdam</freeformAddress>
              <localName>Amsterdam</localName>
              <municipality>Amsterdam</municipality>
              <postalCode>1017 BV</postalCode>
              <streetNumber>505</streetNumber>
              <streetName>Herengracht</streetName>
          </address>
          <openingHours>
              <mode>nextSevenDays</mode>
              <timeRanges>
                  <timeRange>
                      <startTime>
                          <date>2024-05-02</date>
                          <hour>0</hour>
                          <minute>0</minute>
                      </startTime>
                      <endTime>
                          <date>2024-05-09</date>
                          <hour>0</hour>
                          <minute>0</minute>
                      </endTime>
                  </timeRange>
              </timeRanges>
          </openingHours>
          <timeZone>
              <ianaId>Europe/Amsterdam</ianaId>
          </timeZone>
          <accessType>Public</accessType>
          <chargingStations>
              <chargingStation>
                  <id>67335c40-4e72-11e8-8f53-42010a840002</id>
                  <chargingPoints>
                      <chargingPoint>
                          <evseId>NL-GFX-EEVB-P1552388-1</evseId>
                          <physicalReference>1552388</physicalReference>
                          <status>Occupied</status>
                          <capabilities>
                              <capability>RemoteStartStopCapable</capability>
                              <capability>RfidReader</capability>
                          </capabilities>
                          <connectors>
                              <connector>
                                  <id>1</id>
                                  <currentA>16</currentA>
                                  <currentType>AC3</currentType>
                                  <ratedPowerKW>11.0</ratedPowerKW>
                                  <type>IEC62196Type2Outlet</type>
                                  <voltageV>230</voltageV>
                              </connector>
                          </connectors>
                      </chargingPoint>
                      <chargingPoint>
                          <evseId>NL-GFX-EEVB-P1552388-2</evseId>
                          <physicalReference>1552388</physicalReference>
                          <status>OutOfService</status>
                          <capabilities>
                              <capability>RemoteStartStopCapable</capability>
                              <capability>RfidReader</capability>
                          </capabilities>
                          <connectors>
                              <connector>
                                  <id>2</id>
                                  <currentA>16</currentA>
                                  <currentType>AC3</currentType>
                                  <ratedPowerKW>11.0</ratedPowerKW>
                                  <type>IEC62196Type2Outlet</type>
                                  <voltageV>230</voltageV>
                              </connector>
                          </connectors>
                      </chargingPoint>
                  </chargingPoints>
              </chargingStation>
          </chargingStations>
          <paymentOptions>
              <paymentOption>
                  <brands>
                      <brand>
                          <name>Plugsurfing</name>
                      </brand>
                      <brand>
                          <name>Vattenfall InCharge - Incharge</name>
                      </brand>
                      <brand>
                          <name>EVBox Charge</name>
                      </brand>
                      <brand>
                          <name>Shell Recharge</name>
                      </brand>
                      <brand>
                          <name>Vandebron</name>
                      </brand>
                  </brands>
              </paymentOption>
          </paymentOptions>
          <nearbyPois>
              <nearbyPoi>
                  <categoryId>7315</categoryId>
              </nearbyPoi>
              <nearbyPoi>
                  <categoryId>9932</categoryId>
              </nearbyPoi>
          </nearbyPois>
          <vehicleConstraint>
              <types>
                  <type>Car</type>
                  <type>Truck</type>
              </types>
              <categories>
                  <category>N1</category>
                  <category>N2</category>
                  <category>N3</category>
                  <category>N3+O4</category>
              </categories>
              <height>2.75</height>
              <width>2.5</width>
              <length>15.0</length>
              <weight>13500</weight>
              <brands>
                  <brand>
                      <name>Tesla</name>
                  </brand>
                  <brand>
                      <name>Rivian</name>
                  </brand>
              </brands>
          </vehicleConstraint>
      </item>
  </results>
293</response>

Response fields

The following table describes all 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.

Primary fields
Field	Description
`summary` object	Summary information about the search that was performed.
`results` array	Array of `result` objects.

summary object
Field	Description
`numResults` integer	Number of results in the response.
`totalResults` integer	Total number of results found.

results array
Field	Description
`id` string	EV POI Id.
`name` string	Name of the POI.
`position` object	`Position` of the EV POI.
`chargingStations` array	Array of `chargingStation` objects.
`address` object	Structured `address` for the result.
`phone` string	Phone number of the POI.
`openingHours` object	Opening hours for the POI.
`timeZone` object	Time zone for the POI.
`brands` array	Array of `brand` objects. Brands available at the POI.
`paymentOptions` array	Array of `paymentOption` objects.
`nearbyPois` array	Array of `nearbyPoi`. Nearby POIs are points of interest within walking distance of the charging stations that users can explore while charging their vehicles.
`accessType` string	Access type of the EV POI station. Enum: Public: No restriction, POI is open for public use. Authorized: Restriction applies, often requires a permit or registration, i.e., `EmployeesOnly`. Restricted: Restricted POIs are public locations with the intention to be used by a certain member of the public, i.e., `ResidentsOnly`. Private: Private POIs are locations that are not open to the public.
`vehicleConstraint` object	Vehicle constraint of the EV POI.

position
Field	Description
`lat` double	Latitude of the result.
`lon` double	Longitude of the result.

chargingStation
Field	Description
`id` string	Charging station Id.
`chargingPoints` object	Array of `chargingPoint` objects.

chargingPoints
Field	Description
`capabilities` `string` (list)	List of capabilities. Enum: `ChargingProfileCapable`: The charging point supports charging profiles. `ChargingPreferencesCapable`: The charging point supports charging preferences. `ChipCardSupport`: The charging point has a payment terminal that supports chip cards. `ContactlessCardSupport`: The charging point has a payment terminal that supports contactless cards. `CreditCardPayable`: The charging point has a payment terminal that supports credit cards. `DebitCardPayable`: The charging point has a payment terminal that supports debit cards. `PedTerminal`: The charging point has a payment terminal with a pin-code entry device. `RemoteStartStopCapable`: The charging point supports remote start and stop functionality. `Reservable`: The charging point can be reserved. `RfidReader`: Charging at this point can be authorized with an RFID token. `StartSessionConnectorRequired`: When a StartSession is sent to the charging point, the MSP must add the optional connector id field in the StartSession object. `TokenGroupCapable`: The charging point supports token groups. Two or more tokens work as one so that a session can be started with one token and stopped with another (handy when a card and key-fob are given to the EV-driver). `UnlockCapable`: The connectors of the charging point have a mechanical lock that the eMSP can request to be unlocked. `PlugAndCharge`: The charging point is compliant with ISO-15118 Plug and Charge functionality.
`connectors` array	Array of `connector` objects.
`id` string	Charging point Id.
`evseId` string	The EVSE ID is a unique alphanumeric code assigned to each individual charging point (or connector) within a station or network. It's essential for identifying specific chargers in public or roaming charging systems, enabling apps and providers to locate, authenticate, and bill for sessions accurately.
`physicalReference` string	Physical identification of the charging station printed on the station and visible to the driver. One of the parameters that can be used for booking or charging purposes to locate the physical station. No standard format is available.
`restrictions` string (list)	List of parking restrictions. Enum: `evOnly`: Reserved parking spot for electric vehicles. `plugged`: Parking is only allowed while plugged in (charging). `disabled`: Reserved parking spot for disabled people with a valid ID. `customers`: Parking spot for customers/guests only, for example in case of a hotel or shop. `motorcycles`: Parking spot only suitable for (electric) motorcycles or scooters.
`status` string	Dynamic availability status of charging point. Enum: Available Reserved Occupied OutOfService Unknown

connector
Field	Description
`id` string	Id of the connector.
`currentA` integer	Amperage in amperes[A].
`currentType` string	The current type of the connector. Enum: AC1 AC3 DC
`ratedPowerKW` double	Rated charging power in kilowatts[KW].
`type` string	The connector type which is one of the supported types.
`voltageV` integer	Voltage in volts[V].

address object
Field	Description
`countryCode` string	The two-letter code of the country.
`countryCodeISO3` string	ISO alpha-3 country code.
`country` string	The country name.
`countrySubdivision` string	State or Province. For regions like USA, CAN, & GB, this will be the province code, and for the rest the subdivision name.
`countrySecondary Subdivision` string	Country.
`countryTertiary Subdivision` string	Named area.
`countrySubdivisionName` string	State or Province name.
`countrySubdivisionCode` string	State or Province code. Only for regions like USA, CAN, GB.
`countrySubdivisionName` string	The full name of the first level of a country's administrative hierarchy. This field appears only in case `countrySubdivision` is presented in an abbreviated form. Supported only for USA, Canada, and Great Britain.
`freeformAddress` string	An address line formatted according to the formatting rules of the result's country of origin.
`localName` string	An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit.
`municipality` string	City / Town.
`municipality Subdivision` string	Sub / Super City.
`postalCode` string	Postal code / Zip code.
`extendedPostalCode` string	Extended postal code (availability dependent on region).
`streetNumber` string	The building number on the street.
`streetName` string	The street name.

openingHours object
Field	Description
`mode` string	Requested mode for opening hours. Value: `nextSevenDays`
`timeRanges` array	List of time ranges for the next 7 days. Array of `timeRange`.

timeRanges array
Field	Description
`startTime` object	Start of the `timeRange` in the form of `dateHourMinute`.
`endTime` object	End of the `timeRange` in the form of `dateHourMinute`.

dateHourMinute object
Field	Description
`date` string	The date in the calendar year in the local time zone.
`hour` integer	Possible values: `0` - `23`
`minute` integer	Possible values: `0` - `59`

timeZone
Field	Description
`ianaId` string	ID from the IANA Time Zone Database.

brand
Field	Description
`id` string	Brand Id.
`name` string	Brand name.

paymentOption

Field Description

paymentOption
'method' string	Payment method. Enum: subscription
`brands` array	Array of `payment option brand` objects.

'method' string

Payment method.
Enum:

subscription

brands array Array of payment option brand objects.

payment option brand
Field	Description
`id` string	Unique identifier of the payment option.
`name` string	Name of the payment option.
`restricted` boolean	Indicates if payment option is restricted to the current request.

nearbyPoi

Field Description

nearbyPoi
`categoryId` integer	Category Id of the nearby POI. Enum: 7315 - Restaurant 9932 - Public Amenity 9376 - Café/Pub 7314 - Hotel/Motel 9361 - Shop 9362 - Park Recreation Area

categoryId integer

Category Id of the nearby POI.
Enum:

7315 - Restaurant
9932 - Public Amenity
9376 - Café/Pub
7314 - Hotel/Motel
9361 - Shop
9362 - Park Recreation Area

vehicleConstraint
Field	Description
`types` string (list)	Vehicle types constraint of the result. Enum: Car Truck
`categories` string (list)	Vehicle categories constraint of the result. Enum: N1 N2 N3 N3+O4
`length` double	Vehicle length —in meters— constraint of the result.
`height` double	Vehicle height —in meters— constraint of the result.
`width` double	Vehicle width —in meters— constraint of the result.
`weight` integer	Vehicle weight —in kg— constraint of the result.
`brands` object	Array of `vehicleBrand` objects.

vehicle brand
Field	Description
`name` string	Vehicle brand name.

Response codes

Code	Meaning & possible causes
`200`	OK: If any matching charging station was found, the body of the response will contain the data. Otherwise, an empty response will be returned: Empty response example - JSON 1{ 2 "summary": { 3 "numResults": 0, 4 "totalResults": 0 5}}
`400`	Bad request: One or more parameters were incorrectly specified or are out of range.
`403`	Forbidden: Possible causes include: Forbidden Not authorized Account inactive Account over queries per second limit Rate limit exceeded
`404`	Not Found: The requested resource could not be found, the HTTP request method or path is incorrect.
`405`	Method Not Allowed : The client used an HTTP method other than `GET`.
`406`	Media Type Not Acceptable
`414`	The requested URI is too long
`429`	Too Many Requests: The API Key is over QPS (Queries per second).
`5xx`	Server Error: The service was unable to process your request. Contact support to resolve the issue.

Response headers

The following table lists HTTP response headers.

Header	Description
Access-Control-Allow-Origin	The EV Search 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 EV Search 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`
Tracking-ID	An identifier for the request. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service. It is only meant to be used for support and does not involve tracking of you or your users in any form. Value: An `identifier` for the request.

Error response

The error response content type depends on the Accept header.

Error response example - JSON
1{
2  "message": "Missing parameter 'parameterName'",
3  "detailedError": {
4    "code": "MissingParameter",
5    "message": "Missing required parameter 'parameterName'."
6  },
7  "httpStatusCode": "400"
8}

Error response example - XML
1<ErrorEvResponse>
2  <message>Missing parameter 'parameterName'</message>
3  <detailedError>
4    <code>MissingParameter</code>
5    <message>Missing required parameter 'parameterName'.</message>
6  </detailedError>
7</ErrorEvResponse>

Error response fields

Primary fields	Description
`message` string	A human-readable description of the error.
`detailedError` object	Detailed information about the error. `detailedError` object
detailedError object
Field	Description
`code` string	One of a server-defined set of error codes.
`message` string	A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.