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

query input_object StationListQuery

Deprecated

Deprecated: Replaced by filter & search params

filter input_object StationListFilter

Filter station result

size scalar Int

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

page scalar Int

Page number to return, default: 0

Frequently used fields

id non_null ID

Required

Unique ID of a station

name scalar String

Name of a charging station

address scalar String

Street/block name and house number if available

coordinates object OCPIGeoLocation

Coordinates of a location

evses list EVSE

EVSEs that belong to a station

operator object Operator

Information about an operator

amenities scalar JSON

Amenities located at this location

Other fields

review object ReviewStats

Review of a station

id non_null ID

Required

Unique ID of a station

country_code scalar String

ISO-3166 alpha-2 country code of a station

party_id scalar String

CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard)

publish scalar 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

name scalar String

Name of a charging station

address scalar String

Street/block name and house number if available

city scalar String

City or town

postal_code scalar 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.

state scalar String

State or province of a location, only to be used when relevant

country scalar String

ISO 3166-1 alpha-3 code for the country of this station

coordinates object OCPIGeoLocation

Coordinates of a location

parking_type enum OCPIParkingType

Type of parking at a charge point location

evses list EVSE

EVSEs that belong to a station