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 StationList

    Query parameters

  • size int

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

  • page int

    Page number to return, default: 0

  • Frequently used fields

  • id non_null

    Unique ID of a station

  • name string

    Name of a charging station

  • address 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 json

    Amenties located at this location

  • Other fields

  • review object ReviewStats

    Review of a station

  • country_code string

    ISO-3166 alpha-2 country code of a station

  • party_id string

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

  • 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

  • city string

    City or town

  • 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.

  • state string

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

  • country string

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

  • parking_type enum OCPIParkingType

    Type of parking at a charge point location

  • directions list [OCPIDisplayText]

    Human-readable directions on how to reach a station

  • suboperator object Operator

    Information about a suboperator if applicable

  • owner object Operator

    Information about an owner if available

  • facilities list [OCPIFacility]

    Facilities a charging station belongs to

  • 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)

  • opening_times object OCPIHours

    Times when an EVSEs at a location can be accessed for charging

  • 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

  • images list [OCPIImage]

    Links to images related to a location such as photos or logos

  • energy_mix object OCPIEnergyMix

    Details of the energy supplied at a location

  • last_updated datetime

    Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created)

  • external_id string

    ID provided by a station data source

  • location object Point

    GeoJSON location of a charging station

  • elevation int

    Elevation (altitude) level

  • chargers list [Charger]

    Groups of EVSEs by power and type

  • physical_address object Address

    Enriched information about the physical address of a station

  • 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

    A flag that indicates if a station is on private property

  • power json

    Connectors grouped by power

  • predicted_availability list [StationPredictedAvailability]
    Deprecated

    Station availability

  • predicted_occupancy list [StationPredictedOccupancy]

    Predicted station occupancy

  • speed enum StationSpeedType

    Charging speed for a station

  • status enum ChargerStatus

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