To navigate

    To select

    algolia
    Developers Sign in Sign up
    Home
    Getting Started
    API Basics
    # Getting started
    # Authorization
    # Security
    # Status & Error Codes
    # Subscriptions
    Other Basics
    # GraphQL Basics
    # EV Basics
    API Reference
    API
    # Quick setup guide
    # Pagination
    Cars
    # Introduction
    # Query cars
    # Query car details
    # Query premium car details
    Stations
    # Introduction
    # Query stations
    # Query station details
    # Query stations around a GeoJSON point
    # Query station reviews
    # Mutate to create a station review
    # Subscribe to station updates
    # Query station operators
    # Query station operator details
    # Query station tariffs
    # Query station tariff details
    # Query station amenities
    # Query station statistics
    Routes
    # Introduction
    # Mutate to create a new route
    # Subscribe to route updates
    # Query route details
    # Query route path
    Navigation
    # Introduction
    # Mutate to start a new navigation session
    # Subscribe to navigation updates
    # Query navigation session
    # Mutate to update a navigation session
    # Mutate to recalculate navigation
    # Mutate to finish navigation
    Connected Car Data
    # Introduction
    # Telemetry
    Tile Service
    # Introduction
    # Properties
    # Filters
    # Integration
    Release notes
    Deprecations
    Help center
    Playground
    Voyager
    Examples
    Github
    Website
    Documentation
    Sign up
    Dark mode
    Note

    This subscription is marked as deprecated and will be removed at the end of December 2021. After that date the subscription will no longer be available and unexpected behaviour may occur. See deprecations for more information.

    Subscribe to station updates

    If a route is calculated and it includes several stations, you might want to receive status updates from these stations. To prevent you from making too many requests, you can make use of the station updates subscription. This service will let you know whenever a station's availability has changed or when a review was added.

    Explore on the playground

    Subscription

    To use the subscription service you will need a station id that can be obtained from queries like stations or route details.

    Arguments

  • id • non_null
    Required

    The station ID

  • 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

    Amenities 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

  • related_locations • list • [OCPIAdditionalGeoLocation]

    Geographical location of related points relevant to a user

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

    Subscription
    subscription stationUpdatedById($stationId: ID!) {  stationUpdatedById(id: $stationId) {    id    external_id    country_code    party_id    name    address    city    postal_code    state    country    coordinates {      latitude      longitude    }    related_locations {      latitude      longitude    }    parking_type    evses {      uid      evse_id      status      status_schedule {        period_begin        period_end        status      }      capabilities      connectors {        id        standard        format        power_type        max_voltage        max_amperage        max_electric_power        power        tariff_ids        terms_and_conditions        last_updated        properties      }      floor_level      coordinates {        latitude        longitude      }      physical_reference      parking_restrictions      images {        url        thumbnail        category        type        width        height      }      last_updated      parking_cost      properties    }    directions {      language      text    }    operator {      id      external_id      name      website      logo {        url        thumbnail        category        type        width        height      }      country      contact {        phone        email        website        facebook        twitter        properties      }    }    suboperator {      id      name    }    owner {      id      name    }    facilities    time_zone    opening_times {      twentyfourseven      regular_hours {        weekday        period_begin        period_end      }      exceptional_openings {        period_begin        period_end      }      exceptional_closings {        period_begin        period_end      }    }    charging_when_closed    images {      url      thumbnail      category      type      width      height    }    last_updated    location {      type      coordinates    }    elevation    chargers {      standard      power      price      speed      status {        free        busy        unknown        error      }      total    }    physical_address {      continent      country      county      city      street      number      postalCode      what3Words      formattedAddress    }    amenities    properties    realtime    power    speed    status    review {      rating      count    }  }}
    Response
    {  "data": {    "station": {      "id": "5ed60329e5b87c5f9d4e2ab9",      "external_id": "157371",      "country_code": "US",      "party_id": null,      "name": "Fargo, ND Supercharger",      "address": "5680 23RD Avenue South",      "city": "Fargo",      "postal_code": "58104",      "state": "ND",      "country": "USA",      "coordinates": {        "latitude": "46.843599",        "longitude": "-96.881833"      },      "related_locations": [],      "parking_type": null,      "evses": [        {          "uid": "226672",          "evse_id": "0",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "1",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "2",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "3",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "4",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "5",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "6",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        },        {          "uid": "226672",          "evse_id": "7",          "status": "UNKNOWN",          "status_schedule": [],          "capabilities": [],          "connectors": [            {              "id": null,              "standard": "TESLA_S",              "format": null,              "power_type": null,              "max_voltage": 0,              "max_amperage": 0,              "max_electric_power": 120000,              "power": 120,              "tariff_ids": [],              "terms_and_conditions": null,              "last_updated": "2020-08-29T06:18:33.778Z",              "properties": null            }          ],          "floor_level": null,          "coordinates": {            "latitude": "46.843599",            "longitude": "-96.881833"          },          "physical_reference": null,          "parking_restrictions": [],          "images": [],          "last_updated": "2020-08-29T06:18:33.778Z",          "parking_cost": null,          "properties": null        }      ],      "directions": null,      "operator": {        "id": "5e947c91e33701a381770657",        "external_id": "23",        "name": "Tesla Motors (Worldwide)",        "website": "http://www.teslamotors.com",        "logo": null,        "country": null,        "contact": {          "phone": "",          "email": "",          "website": "http://www.teslamotors.com",          "facebook": null,          "twitter": null,          "properties": null        }      },      "suboperator": null,      "owner": null,      "facilities": [        "NATURE",        "RESTAURANT",        "CAFE",        "HOTEL",        "RECREATION_AREA"      ],      "time_zone": null,      "opening_times": {        "twentyfourseven": false,        "regular_hours": [],        "exceptional_openings": [],        "exceptional_closings": []      },      "charging_when_closed": true,      "images": [],      "last_updated": "2020-08-29T06:18:33.778Z",      "location": {        "type": "Point",        "coordinates": [          -96.881833,          46.843599        ]      },      "elevation": 442,      "chargers": [        {          "standard": "TESLA_S",          "power": 120,          "price": "",          "speed": "fast",          "status": {            "free": 0,            "busy": 0,            "unknown": 8,            "error": 0          },          "total": 8        }      ],      "physical_address": {        "continent": "NA",        "country": "US",        "county": "ND",        "city": "Fargo",        "street": "5680 23RD Avenue South",        "number": null,        "postalCode": "58104",        "what3Words": "clarifies.agreement.flattening",        "formattedAddress": [          "5680 23RD Avenue South, 58104",          "Fargo, ND",          "United States"        ]      },      "amenities": {        "park": 1,        "restaurant": 5,        "museum": 0,        "coffee": 4,        "hotel": 5,        "shopping": 0,        "bathroom": 0,        "supermarket": 0,        "playground": 1,        "pharmacy": 2      },      "properties": null,      "realtime": false,      "power": {        "120": {          "total": 1,          "available": 0        }      },      "speed": "fast",      "status": "unknown",      "review": {        "rating": 5,        "count": 1      }    }  }}