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 filter argument. You can use the filter: { amenities: [restaurant], power_groups: [turbo] } to return all stations with turbo chargers and a restaurant in the proximity.

To search a station by name, station id, or EVSE id you can use the search argument.

Arguments

query StationListQuery

Deprecated

Deprecated: Replaced by filter & search params.

filter StationListFilter

Filter station result.

size Int

Number of elements (count) to return, default: 10.

page Int

Page number to return, default: 0.

Frequently used fields

id ID

Unique ID of a station. This property is OCPI-compliant.

name String

Name of a charging station. This property is OCPI-compliant.

address String

Street/block name and house number if available. This property is OCPI-compliant.

coordinates OCPIGeoLocation

Coordinates of a location. This property is OCPI-compliant.

evses EVSE

EVSEs that belong to a station. This property is OCPI-compliant.

operator Operator

Information about an operator. This property is OCPI-compliant.

amenities JSON

Amenities located at this location.

Other fields

country_code String

ISO-3166 alpha-2 country code of a station. This property is OCPI-compliant.

party_id String

CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard). This property is OCPI-compliant.

publish Boolean

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. This property is OCPI-compliant.

city String

City or town. This property is OCPI-compliant.

postal_code String

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. This property is OCPI-compliant.

state String

State or province of a location, only to be used when relevant. This property is OCPI-compliant.

country String

ISO 3166-1 alpha-3 code for the country of this station. This property is OCPI-compliant.

parking_type OCPIParkingType

Type of parking at a charge point location. This property is OCPI-compliant.

Show OCPIParkingType enum values

directions OCPIDisplayText

Human-readable directions on how to reach a station. This property is OCPI-compliant.

suboperator Operator

Information about a suboperator if applicable. This property is OCPI-compliant.

owner Operator

Information about an owner if available. This property is OCPI-compliant.

facilities OCPIFacility

Facilities a charging station belongs to. This property is OCPI-compliant.

Show OCPIFacility enum values

time_zone String

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). This property is OCPI-compliant.

opening_times OCPIHours

Times when an EVSEs at a location can be accessed for charging. This property is OCPI-compliant.

charging_when_closed Boolean

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. This property is OCPI-compliant.

images OCPIImage

Links to images related to a location such as photos or logos. This property is OCPI-compliant.

energy_mix OCPIEnergyMix

Details of the energy supplied at a location. This property is OCPI-compliant.

last_updated DateTime

Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created). This property is OCPI-compliant.

external_id String

ID provided by a station data source.

location Point

GeoJSON location of a charging station.

elevation Int

Elevation (altitude) level.

chargers Charger

Groups of EVSEs by power and type.

physical_address Address

Enriched information about the physical address of a station.

heavy_vehicles_properties StationHeavyVehiclesProperties

Describes the heavy vehicle properties at the location.

heavy_vehicles_restrictions StationHeavyVehiclesRestrictions

Describes the heavy vehicle restrictions at the location.

vehicle_restrictions StationVehicleRestrictions

Describes the vehicle restrictions at the location.

location_category String

Type of location where the charge point is located. For example, shop.

entrance_for_navigation OCPIAdditionalGeoLocation

Coordinates for the location's entrances in decimal degrees. If available, there can be more than one entrances to the location.

properties JSON

Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.

realtime Boolean

A flag that indicates if a station has real-time information about the availability of its connectors.

private Boolean

Deprecated

A flag that indicates if a station is on private property.

power JSON

Connectors grouped by power.

predicted_availability StationPredictedAvailability

Deprecated

Station availability.

predicted_occupancy StationPredictedOccupancy

Predicted station occupancy.

speed StationSpeedType

Charging speed for a station.

Show StationSpeedType enum values

status ChargerStatus

Global status for a station.

Show ChargerStatus enum values

custom_properties StationCustomProperties

Custom properties of a station. These are vendor specific and will return null values on the fields that are not supported by your station database.

review ReviewStats

Review of a station.

roaming StationRoaming

List of eMSP cards accepted at a charging station.

support_phone_number String

Phone number for assistance at a charging station.

charging_behaviour ChargingBehaviour

Charging behavior of a station.

reliability_score Int

Shows how reliable a charging station is (1 to 5; 1 = unreliable, 5 = reliable), taking into account the charging behaviour history and error values.

adhoc_authorisation_payment_method StationAdhocAuthorisationPaymentMethod

Indicates the authentication and payment methods.

Show StationAdhocAuthorisationPaymentMethod enum values

access_type AccessType

Type of access to the charging station.

Show AccessType enum values

Response

A response can either contain a data or an errors object. The response header will always return 200 as a status code.

Data object

When successful, a data object will be returned with the requested fields. If there are no fields present the data object will return the operation name with the appropriate return type. If the operation was a query, this output will be an object of the schema’s query root type; if the operation was a mutation, this output will be an object of the schema’s mutation root type.

Error object

If unsuccessful, an errors object will be returned with more details in the extensions object. The error object can contain any of the following objects.