Query stations
To be able to browse through all your stations inside your station database you can use the stationList
query. While querying you will have access to all station properties. You can set the size property to specify how many stations you would like to receive, the default is 10. Keep your query as small as possible to improve the performance.
Query
To query your stations you only need to call the stationList
alongside the properties you would like to receive. Optionally you can add pagination and filters
.
Filters
To filter your station list you can use the query
argument. You can then use name
, id
or external_id
to specify what stations you would like to receive.
Arguments
Deprecated: Replaced by filter & search params
Filter station result
Search for stations by name, id and external id
Number of elements (count) to return, default: 10
Page number to return, default: 0
Frequently used fields
Unique ID of a station
Name of a charging station
Street/block name and house number if available
Coordinates of a location
EVSEs that belong to a station
Information about an operator
Amenities located at this location
Other fields
Review of a station
ISO-3166 alpha-2 country code of a station
CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard)
Defines if a location may be published on a website or app etc. When this is set to false, only tokens identified in the field: publish_allowed_to are allowed to show this location. When the same location has EVSEs that may be published and may not be published, two 'locations' should be created
City or town
Postal code of a location, may only be omitted when a location has no postal code: in some countries charging locations at highways don’t have postal codes.
State or province of a location, only to be used when relevant
ISO 3166-1 alpha-3 code for the country of this station
Geographical location of related points relevant to a user
Type of parking at a charge point location
Human-readable directions on how to reach a station
Information about a suboperator if applicable
Information about an owner if available
Facilities a charging station belongs to
Value from the IANA time zone database representing the time zone of a location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones)
Times when an EVSEs at a location can be accessed for charging
Indicates if the EVSEs are still charging outside the opening hours. E.g. when a parking garage closes its barriers overnight, is it allowed to charge till the next morning? Default: true
Links to images related to a location such as photos or logos
Details of the energy supplied at a location
Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created)
ID provided by a station data source
GeoJSON location of a charging station
Elevation (altitude) level
Groups of EVSEs by power and type
Enriched information about the physical address of a station
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer
A flag that indicates if a station has real-time information about the availability of its connectors
A flag that indicates if a station is on private property
Connectors grouped by power
Station availability
Predicted station occupancy
Charging speed for a station
Global status for a station
Response
If successful, the HTTP status code in the response header is
200
and the response body contains the attributes you
requested.
If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.
Errors & warnings
- Error
ERROR_FORBIDDEN_MESSAGE
You are forbidden to execute this operation
- Error
PAGINATION_INVALID_PAGE
Page must be an INT value higher than 0
- Error
PAGINATION_INVALID_SIZE
Size must be an INT value between 1 and 1000