Create a new station review
To improve the user experience of routes you can include reviews as described in query station reviews. To collect reviews and allow users to write one, you will need to use the following mutation.
Mutation
To be able to write a review you will need a stationId and carId. After that you can use various review arguments like rating, message and tags to collect the appropriate data. Keep in mind, the stationId and rating are both required when submitting a review.
Arguments
review • ReviewAdd
• Required
stationId • String
• Required
Station ID for which a review is provided.
rating • Int
• Required
Rating of a review.
message • String
Review message.
locale • String
Locale of a message.
ev • String
ID of the vehicle that was provided/selected by a user.
plugType • ConnectorType
Plug type that was provided/selected by a user.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
tags • ReviewTagsInput
Boolean tags for a station review.
working • Boolean
Flag which indicates if a station was working when the review was added.
recommended • Boolean
Flag which indicates if a user recommended a station when the review was added.
Other fields
id • ID
ID of a review.
station • Station
Station for which a review was provided.
id • ID
Unique ID of a station. This property is OCPI-compliant.
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.
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.
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.
coordinates • OCPIGeoLocation
Coordinates of a location. This property is OCPI-compliant.
latitude • String
Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}. This property is OCPI-compliant.
longitude • String
Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}. This property is OCPI-compliant.
related_locations • OCPIAdditionalGeoLocation
Geographical location of related points relevant to a user. This property is OCPI-compliant.
latitude • String
Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}. This property is OCPI-compliant.
longitude • String
Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}. This property is OCPI-compliant.
name • OCPIDisplayText
Name of the point in local language or as written at the location. For example the street name of a parking lot entrance or it’s number. This property is OCPI-compliant.
language • String
Language Code ISO 639-1. This property is OCPI-compliant.
text • String
Text to be displayed to an end user. No markup, html etc. allowed. 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
ALONG_MOTORWAY
Location on a parking facility/rest area along a motorway, freeway, interstate, highway etc.
PARKING_GARAGE
Multistorey car park.
PARKING_LOT
A cleared area that is intended for parking vehicles, i.e. at supermarkets, bars, etc.
ON_DRIVEWAY
Location is on the driveway of a house/building.
ON_STREET
Parking in public space along a street.
UNDERGROUND_GARAGE
Multistorey car park, mainly underground.
evses • EVSE
EVSEs that belong to a station. This property is OCPI-compliant.
uid • String
Uniquely identifies an EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field evse_id for that. This field is named uid instead of id, because id could be confused with evse_id which is an eMI3 defined field. This property is OCPI-compliant.
evse_id • String
Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects." Optional because: if an evse_id is to be re-used in the real world, the evse_id can be removed from an EVSE object if the status is set to REMOVED. This property is OCPI-compliant.
status • OCPIStatus
Indicates the current status of an EVSE. This property is OCPI-compliant.
Show OCPIStatus enum values
AVAILABLE
The EVSE/Connector is able to start a new charging session.
BLOCKED
The EVSE/Connector is not accessible because of a physical barrier, i.e. a car.
CHARGING
The EVSE/Connector is in use.
INOPERATIVE
The EVSE/Connector is not yet active or it is no longer available (deleted).
OUTOFORDER
The EVSE/Connector is currently out of order.
PLANNED
The EVSE/Connector is planned, will be operating soon.
REMOVED
The EVSE/Connector was discontinued/removed.
RESERVED
The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers.
UNKNOWN
No status information available (also used when offline).
status_schedule • OCPIStatusSchedule
Indicates a planned status update of a nEVSE. This property is OCPI-compliant.
period_begin • DateTime
Begin of the scheduled period. This property is OCPI-compliant.
period_end • DateTime
End of the scheduled period, if known. This property is OCPI-compliant.
status • OCPIStatus
Status value during the scheduled period. This property is OCPI-compliant.
Show OCPIStatus enum values
AVAILABLE
The EVSE/Connector is able to start a new charging session.
BLOCKED
The EVSE/Connector is not accessible because of a physical barrier, i.e. a car.
CHARGING
The EVSE/Connector is in use.
INOPERATIVE
The EVSE/Connector is not yet active or it is no longer available (deleted).
OUTOFORDER
The EVSE/Connector is currently out of order.
PLANNED
The EVSE/Connector is planned, will be operating soon.
REMOVED
The EVSE/Connector was discontinued/removed.
RESERVED
The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers.
UNKNOWN
No status information available (also used when offline).
capabilities • OCPICapability
List of functionalities that an EVSE is capable of. This property is OCPI-compliant.
Show OCPICapability enum values
CHARGING_PROFILE_CAPABLE
The EVSE supports charging profiles.
CHARGING_PREFERENCES_CAPABLE
The EVSE supports charging preferences.
CHIP_CARD_SUPPORT
EVSE has a payment terminal that supports chip cards.
CONTACTLESS_CARD_SUPPORT
EVSE has a payment terminal that supports contactless cards.
CREDIT_CARD_PAYABLE
EVSE has a payment terminal that makes it possible to pay for charging using a credit card.
DEBIT_CARD_PAYABLE
EVSE has a payment terminal that makes it possible to pay for charging using a debit card.
PED_TERMINAL
EVSE has a payment terminal with a pin-code entry device.
REMOTE_START_STOP_CAPABLE
The EVSE can remotely be started/stopped.
RESERVABLE
The EVSE can be reserved.
RFID_READER
Charging at this EVSE can be authorized with an RFID token.
TOKEN_GROUP_CAPABLE
This EVSE supports token groups, two or more tokens work as one, so that a session can be started with one token and stopped with another (handy when a card and key-fob are given to the EV-driver).
UNLOCK_CAPABLE
Connectors have a mechanical lock that can be requested by the eMSP to be unlocked.
START_SESSION_CONNECTOR_REQUIRED
When a StartSession is sent to this EVSE, the MSP is required to add the optional connector_id field in the StartSession object.
connectors • Connector
List of available connectors on an EVSE. This property is OCPI-compliant.
id • String
Identifier of a connector within an EVSE. Two connectors may have the same ID as long as they do not belong to the same EVSE object. This property is OCPI-compliant.
standard • ConnectorType
Standard of an installed connector. This property is OCPI-compliant.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
format • OCPIConnectorFormat
Format (socket/cable) of an installed connector. This property is OCPI-compliant.
Show OCPIConnectorFormat enum values
SOCKET
The connector is a socket; the EV user needs to bring a fitting plug.
CABLE
The connector is an attached cable; the EV users car needs to have a fitting inlet.
power_type • OCPIPowerType
Type of power of an installed connector. This property is OCPI-compliant.
Show OCPIPowerType enum values
AC_1_PHASE
AC single phase.
AC_3_PHASE
AC three phase.
AC_2_PHASE
AC two phases, only two of the three available phases connected.
AC_2_PHASE_SPLIT
AC two phases using split phase system.
DC
Direct Current.
max_voltage • Int
Maximum voltage of an connector (line to neutral for AC_3_PHASE), in volt [V]. For example: DC Chargers might vary the voltage during charging when battery almost full. This property is OCPI-compliant.
max_amperage • Int
Maximum amperage of a connector, in ampere [A]. This property is OCPI-compliant.
max_electric_power • Int
Maximum electric power that can be delivered by a connector, in watt [W]. When the maximum electric power is lower than the calculated value from voltage and amperage, this value should be set. For example: A DC Charge Point which can deliver up to 920V and up to 400A can be limited to a maximum of 150kW. Depending on the vehicle, it may supply maximum voltage or current, but not both at the same time. For AC Charge Points, the amount of phases used can also have influence on the maximum power. This property is OCPI-compliant.
power • Float
Maximum electric power in kW.
tariff_ids • String
Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed, if they are not active at the same time: start_date_time and end_date_time period not overlapping. When preference-based smart charging is supported, one tariff for every possible ProfileType should be provided. This tells the user about the options they have at this Connector, and what the tariff is for every option. For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff. This property is OCPI-compliant.
terms_and_conditions • String
URL to an operator’s terms and conditions. This property is OCPI-compliant.
last_updated • DateTime
Timestamp when a connector was last updated (or created). This property is OCPI-compliant.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
tariff • OCPITariff
List of valid charging tariffs.
country_code • String
ISO-3166 alpha-2 country code of the CPO that owns this tariff. This property is OCPI-compliant.
party_id • String
CPO ID of the CPO that owns this tariff (following the ISO-15118 standard). This property is OCPI-compliant.
id • String
Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms). This property is OCPI-compliant.
currency • String
ISO-4217 code of the currency of this tariff. This property is OCPI-compliant.
type • OCPITariffType
Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions. This property is OCPI-compliant.
Show OCPITariffType enum values
AD_HOC_PAYMENT
Used to describe that a tariff is valid when ad-hoc payment is used at the charge point (for example: Debit or Credit card payment terminal)
PROFILE_CHEAP
Used to describe that a tariff is valid when charging preference: CHEAP is set for the session
PROFILE_FAST
Used to describe that a tariff is valid when charging preference: FAST is set for the session
PROFILE_GREEN
Used to describe that a tariff is valid when charging preference: GREEN is set for the session
REGULAR
Used to describe that a tariff is valid when using an RFID, without any charging preference, or when charging preference: REGULAR is set for the session
tariff_alt_text • OCPIDisplayText
List of alternative tariff information texts, in multiple languages. This property is OCPI-compliant.
language • String
Language Code ISO 639-1. This property is OCPI-compliant.
text • String
Text to be displayed to an end user. No markup, html etc. allowed. This property is OCPI-compliant.
tariff_alt_url • String
URL to a web page that contains an explanation of the tariff information in human readable form. This property is OCPI-compliant.
min_price • OCPIPrice
When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount. This property is OCPI-compliant.
excl_vat • Float
Price/Cost excluding VAT. This property is OCPI-compliant.
incl_vat • Float
Price/Cost including VAT. This property is OCPI-compliant.
max_price • OCPIPrice
When this field is set, a charging session with this tariff will NOT cost more than this amount. This property is OCPI-compliant.
excl_vat • Float
Price/Cost excluding VAT. This property is OCPI-compliant.
incl_vat • Float
Price/Cost including VAT. This property is OCPI-compliant.
elements • OCPITariffElement
List of tariff elements. This property is OCPI-compliant.
price_components • OCPIPriceComponent
List of price components that describe the pricing of a tariff. This property is OCPI-compliant.
type • OCPITariffDimensionType
Type of tariff dimension. This property is OCPI-compliant.
Show OCPITariffDimensionType enum values
ENERGY
Defined in kWh, step_size multiplier: 1 Wh
FLAT
Flat fee without unit for step_size
PARKING_TIME
Time not charging: defined in hours, step_size multiplier: 1 second
TIME
Time charging: defined in hours, step_size multiplier: 1 second Can also be used in combination with a RESERVATION restriction to describe the price of the reservation time.
price • Float
Price per unit (excl. VAT) for this tariff dimension. This property is OCPI-compliant.
vat • Float
Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable. Not providing a VAT is different from 0% VAT, which would be a value of 0.0 here. This property is OCPI-compliant.
step_size • Int
Minimum amount to be billed. This unit will be billed in this step_size blocks. For example: if type is TIME and step_size has a value of 300, then time will be billed in blocks of 5 minutes. If 6 minutes were used, 10 minutes (2 blocks of step_size) will be billed. This property is OCPI-compliant.
restrictions • OCPITariffRestrictions
Restrictions that describe the applicability of a tariff. This property is OCPI-compliant.
start_time • String
Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. This property is OCPI-compliant.
end_time • String
End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time. This property is OCPI-compliant.
start_date • String
Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]). This property is OCPI-compliant.
end_date • String
End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date. This property is OCPI-compliant.
min_kwh • Float
Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used. This property is OCPI-compliant.
max_kwh • Float
Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used. This property is OCPI-compliant.
min_current • Float
Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value. This property is OCPI-compliant.
max_current • Float
Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current raises above the defined value. This property is OCPI-compliant.
min_power • Float
Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value. This property is OCPI-compliant.
max_power • Float
Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value. This property is OCPI-compliant.
min_duration • Float
Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active. This property is OCPI-compliant.
max_duration • Float
Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active. This property is OCPI-compliant.
day_of_week • OCPIDayOfWeek
Which day(s) of the week this tariff element is active. This property is OCPI-compliant.
Show OCPIDayOfWeek enum values
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
reservation • OCPIReservationRestrictionType
When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation. This property is OCPI-compliant.
Show OCPIReservationRestrictionType enum values
RESERVATION
Used in TariffElements to describe costs for a reservation.
RESERVATION_EXPIRES
Used in TariffElements to describe costs for a reservation that expires (i.e. driver does not start a charging session before expiry_date of the reservation).
start_date_time • DateTime
Time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active. This property is OCPI-compliant.
end_date_time • DateTime
Time after which this tariff is no longer valid, in UTC, time_zone field if the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future. This property is OCPI-compliant.
energy_mix • OCPIEnergyMix
Details about the energy supplied with this tariff. This property is OCPI-compliant.
is_green_energy • Boolean
True if the power is 100% from regenerative sources. This property is OCPI-compliant.
energy_sources • OCPIEnergySource
Key-value pairs (enum + percentage) of energy sources of this location’s tariff. This property is OCPI-compliant.
source • OCPIEnergySourceCategory
The type of energy source. This property is OCPI-compliant.
Show OCPIEnergySourceCategory enum values
NUCLEAR
Nuclear power sources.
GENERAL_FOSSIL
All kinds of fossil power sources.
COAL
Fossil power from coal.
GAS
Fossil power from gas.
GENERAL_GREEN
All kinds of regenerative power sources.
SOLAR
Regenerative power from PV.
WIND
Regenerative power from wind turbines.
WATER
Regenerative power from water turbines.
percentage • Int
Percentage of this source (0-100) in the mix. This property is OCPI-compliant.
environ_impact • OCPIEnvironmentalImpact
Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location’s tariff. This property is OCPI-compliant.
category • OCPIEnvironmentalImpactCategory
The environmental impact category of this value. This property is OCPI-compliant.
Show OCPIEnvironmentalImpactCategory enum values
NUCLEAR_WASTE
Produced nuclear waste in g/kWh.
CARBON_DIOXIDE
Exhausted carbon dioxide in g/kWh.
amount • Float
Amount of this portion in g/kWh. This property is OCPI-compliant.
supplier_name • String
Name of the energy supplier, delivering the energy for this location or tariff.*. This property is OCPI-compliant.
energy_product_name • String
Name of the energy suppliers product/tariff plan used at this location.*. This property is OCPI-compliant.
last_updated • DateTime
Timestamp when this tariff was last updated (or created). This property is OCPI-compliant.
pricing • Pricing
Deprecated
Charging prices.
id • String
Unique ID of a price.
price_list • PricingList
Price details.
partner • String
(MSP) Mobility Service Provider.
product • PricingListProduct
Product details.
name • String
Name of the payment card or subscription. If name is 'Adhoc price' the price is the CPO price.
description • String
Description of the product.
subscription_type • String
Subscription type.
subscription_fee_excl_vat • Float
Subscription fee without VAT.
currency • String
Currency.
elements • PricingListElement
Price product elements.
type • PricingListElementType
Price element type.
Show PricingListElementType enum values
ENERGY
Price per kWh.
FLAT
Starting price, fixed fee per charge session.
TIME
Fixed price per hour.
PARKING_TIME
Parking price per hour.
price_excl_vat • Float
Price of the element type without VAT.
vat • Float
VAT percentage to apply.
prices • ConnectorPrice
Dynamic charging prices.
external_id • String
ID for the price.
partner • String
Owner of the payment product.
partner_id • String
ID for the owner of the payment product.
product • ConnectorPriceProduct
Payment product.
name • String
Name of the payment product.
type • ConnectorPriceProductType
Type of the payment product.
Show ConnectorPriceProductType enum values
ad_hoc
msp
cpo_subscription
description • String
A brief description of the product.
subscription_type • ConnectorPriceProductSubscriptionType
Indicates the type of subscription.
Show ConnectorPriceProductSubscriptionType enum values
monthly
The subscription fee is applicable every month.
yearly
The subscription fee is applicable every year.
one_off
An initial fee is applicable to purchase a RFID card or chip, but there isn't a recurring subscription fee.
not_applicable
The product doesn’t have a subscription option.
subscription_fee_excl_vat • Float
Subscription price for a month or year, excluding VAT, if applicable.
currency • CurrencyUnit
Three-digit currency code of the country where the charging station is located.
Show CurrencyUnit enum values
EUR
Return the currency in EUR.
USD
Return the currency in USD.
GBP
Return the currency in GBP.
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BIF
BMD
BND
BOB
BRL
BSD
BWP
BYN
BZD
CAD
CDF
CHF
CLP
CNY
COP
CRC
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ETB
FJD
FKP
GEL
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HTG
HUF
IDR
ILS
INR
ISK
JMD
JPY
KES
KGS
KHR
KMF
KRW
KYD
KZT
LAK
LBP
LKR
LRD
LSL
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SEK
SGD
SHP
SLE
SOS
SRD
STD
SZL
THB
TJS
TOP
TRY
TTD
TWD
TZS
UAH
UGX
UYU
UZS
VND
VUV
WST
XAF
XCD
XOF
XPF
YER
ZAR
ZMW
elements • ConnectorPriceElement
Price product elements.
components • ConnectorPriceElementComponent
Connector price element components.
type • ConnectorPriceElementComponentType
Type of pricing that is applicable.
Show ConnectorPriceElementComponentType enum values
energy
Price per kWh.
flat
Fixed price per charging session.
parking_time
Parking price per hour. This fee is applicable even if the parked car is not charging.
time
Fixed price per hour.
price_excl_vat • Float
Applicable price excluding VAT.
vat • Float
Applicable VAT.
step_size • Int
Indicates the minimum amount that is billed. A
unit is billed in step-size blocks. For example, if the type is TIME and step_size is 300, then the time is billed in blocks of 5 minutes. Hence, if 6 minutes is used, then 10 minutes (2 blocks of step_size) is billed.
Note: step_size also depends on the type. Every type (except FLAT) defines a step_size multiplier. This is the size of every 'step' and the unit. For example, PARKING_TIME has a step-size multiplier of 1 second. Therefore, the step_size of a price component is multiplied by 1 second. Thus, step_size = 300 means 300 seconds.
restrictions • ConnectorPriceElementRestrictions
Connector price element restrictions.
start_time • String
Starting time of the day for the prices.
end_time • String
Ending time of the day for the prices.
start_date • String
Starting date for the prices.
end_date • String
Ending date for the prices.
minimum_kwh • Float
Minimum energy used, in kWh.
maximum_kwh • Float
Maximum energy used, in kWh.
minimum_power • Float
Minimum charging speed, in kW.
maximum_power • Float
Maximum charging speed, in kW.
minimum_current • Float
Sum of the minimum current (in Amperes) over all the phases. When the EV is charging with more than or equal to this value the prices are active. If the charging current is lower, this price is inactive.
maximum_current • Float
Sum of the maximum current (in Amperes) over all the phases. When the EV is charging with less than this value the prices are active. If the charging current is higher, this price is inactive.
minimum_price • Float
Minimum price based on the amount of kWh that is being delivered.
maximum_price • Float
Maximum price based on the amount of kWh that is being delivered.
overstay_battery_percentage • ConnectorPriceRestrictionsOverstayBatteryPercentage
Battery percentage at which the overstay prices are active.
minimum • Int
Battery percentage at which the overstay prices are active.
maximum • Int
Battery percentage at which the overstay prices are inactive.
unit • ConnectorPriceRestrictionsOverstayTimeUnit
Unit for the time after which the prices are active.
Show ConnectorPriceRestrictionsOverstayTimeUnit enum values
seconds
The overstay restrictions are applicable after a certain number of seconds.
minutes
The overstay restrictions are applicable after a certain number of minutes.
hours
The overstay restrictions are applicable after a certain number of hours.
overstay_time • ConnectorPriceRestrictionsOverstayTime
Time after which the overstay prices are active.
minimum • Int
Time at which the overstay prices are active.
maximum • Int
Time at which the overstay prices are inactive.
unit • ConnectorPriceRestrictionsOverstayTimeUnit
Unit for the time after which the prices are active.
Show ConnectorPriceRestrictionsOverstayTimeUnit enum values
seconds
The overstay restrictions are applicable after a certain number of seconds.
minutes
The overstay restrictions are applicable after a certain number of minutes.
hours
The overstay restrictions are applicable after a certain number of hours.
minimum_duration • Int
Minimum duration, in seconds.
maximum_duration • Int
Maximum duration, in seconds.
day_of_week • DayOfWeek
Day(s) of the week that the prices are valid.
Show DayOfWeek enum values
monday
tuesday
wednesday
thursday
friday
saturday
sunday
emsp_contract_date • ConnectorPriceRestrictionsEmspContractDate
Contract signed between the eMSP and the customer.
name • String
Name of the contract signed between the eMSP and a customer.
from • String
Prices are active from this date, which is based on the contract signed between the eMSP and a customer.
to • String
Prices are active until this date, which is based on the contract signed between the eMSP and a customer.
reservation • ConnectorPriceRestrictionsReservationType
When this field is present, the ConnectorPriceElement describes reservation costs.
A reservation starts when the reservation is made, and ends when the driver starts charging on the reserved EVSE/Location,
or when the reservation expires. A reservation can only have: flat and time ConnectorPriceElementComponentType,
where time is for the duration of the reservation.
When a price has both, reservation and reservation_expires ConnectorPriceElement,
where both ConnectorPriceElement have a time ConnectorPriceElementComponent,
then the time based cost of an expired reservation will be calculated based on the reservation_expires ConnectorPriceElement.
Show ConnectorPriceRestrictionsReservationType enum values
reservation
Describes costs for a reservation.
reservation_expires
Describes costs for a reservation that expires (i.e. driver does not start a charging session before expiry date of the reservation).
last_updated • DateTime
Indicates when the pricing data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a price update or any other update (for example, pricing type update).
custom_properties • ConnectorCustomProperties
Custom properties of a connector. These are vendor specific and will return null values on the fields that are not supported by your station database.
pricing • Pricing
Deprecated
Charging prices.
id • String
Unique ID of a price.
price_list • PricingList
Price details.
partner • String
(MSP) Mobility Service Provider.
product • PricingListProduct
Product details.
name • String
Name of the payment card or subscription. If name is 'Adhoc price' the price is the CPO price.
description • String
Description of the product.
subscription_type • String
Subscription type.
subscription_fee_excl_vat • Float
Subscription fee without VAT.
currency • String
Currency.
elements • PricingListElement
Price product elements.
type • PricingListElementType
Price element type.
Show PricingListElementType enum values
ENERGY
Price per kWh.
FLAT
Starting price, fixed fee per charge session.
TIME
Fixed price per hour.
PARKING_TIME
Parking price per hour.
price_excl_vat • Float
Price of the element type without VAT.
vat • Float
VAT percentage to apply.
oicp • OICPConnectorCustomProperties
Custom connector properties for OICP databases. Station databases that not follow the OICP standard return null values.
dynamic_power_level • Boolean
Returns whether the connector is able to deliver different power outputs.
charging_modes • OICPChargingModes
List of charging modes that are supported as specified by IEC 61851-1.
Show OICPChargingModes enum values
mode_1
mode_2
mode_3
mode_4
chademo
floor_level • String
Level on which a Charge Point is located (in garage buildings) in the locally displayed numbering scheme. This property is OCPI-compliant.
coordinates • OCPIGeoLocation
Coordinates of a EVSE. This property is OCPI-compliant.
latitude • String
Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}. This property is OCPI-compliant.
longitude • String
Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}. This property is OCPI-compliant.
physical_reference • String
A number/string printed on the outside of an EVSE for visual identification. This property is OCPI-compliant.
parking_restrictions • OCPIParkingRestriction
Restrictions that apply to a parking spot. This property is OCPI-compliant.
Show OCPIParkingRestriction enum values
EV_ONLY
Reserved parking spot for electric vehicles.
PLUGGED
Parking is only allowed while plugged in (charging).
DISABLED
Reserved parking spot for disabled people with valid ID.
CUSTOMERS
Parking spot for customers/guests only, for example in case of a hotel or shop.
MOTORCYCLES
Parking spot only suitable for (electric) motorcycles or scooters.
images • OCPIImage
Links to images related to an EVSE such as photos or logos. This property is OCPI-compliant.
url • String
URL from where the image data can be fetched through a web browser. This property is OCPI-compliant.
thumbnail • String
URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant.
category • OCPIImageCategory
Category of an image. This property is OCPI-compliant.
Show OCPIImageCategory enum values
CHARGER
Photo of the physical device that contains one or more EVSEs.
ENTRANCE
Location entrance photo. Should show the car entrance to the location from street side.
LOCATION
Location overview photo.
NETWORK
Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATOR
Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present.
OTHER
Other
OWNER
Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.
type • String
Image type: gif, jpeg, png, svg. This property is OCPI-compliant.
width • Int
Width of the full scale image. This property is OCPI-compliant.
height • Int
Height of the full scale image. This property is OCPI-compliant.
last_updated • DateTime
Timestamp when this EVSE or one of its Connectors was last updated (or created). This property is OCPI-compliant.
parking_cost • ParkingCost
Indicates if parking is free or paid.
Show ParkingCost enum values
free
Parking is free.
paid
Parking includes a fee.
cpo_external_id • String
Unique ID of the location in the system of the CPO.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
custom_properties • EvseCustomProperties
Custom properties of an EVSE.
oicp • OICPEvseCustomProperties
OICP standard custom properties.
authentication_modes • OICPEvseAuthenticationMode
List of authentication modes that are supported.
Show OICPEvseAuthenticationMode enum values
nfc_rfid_classic
nfc_rfid_desfire
pnc
remote
direct_payment
no_authentication_required
max_capacity • Int
Returns a value if the EVSE has a limited capacity (e.g. built-in battery). Values are in kWh.
payment_options • OICPPaymentOptions
List of payment options that are supported.
Show OICPPaymentOptions enum values
no_payment
direct
contract
value_added_services • OICPValueAddedServices
List of value added services that are supported.
Show OICPValueAddedServices enum values
reservation
dynamic_pricing
parking_sensors
maximum_power_charging
predictive_charge_point_usage
charging_plans
roof_provided
none
additional_info • OICPEvseCustomPropertiesAdditionalInfo
List of additional info by locale.
lang • String
The language in which the additional info text is provided.
value • String
Additional info text value.
is_hubject_compatible • Boolean
When the value is set to false this station does not support remote start and stop by Hubject.
hardware_manufacturer • String
Name of the charging point manufacturer.
directions • OCPIDisplayText
Human-readable directions on how to reach a station. This property is OCPI-compliant.
language • String
Language Code ISO 639-1. This property is OCPI-compliant.
text • String
Text to be displayed to an end user. No markup, html etc. allowed. This property is OCPI-compliant.
operator • Operator
Information about an operator. This property is OCPI-compliant.
id • ID
Unique operator ID.
external_id • String
External ID of an operator provided by the operator data source.
name • String
Name of an operator. This property is OCPI-compliant.
website • String
Link to an operator’s website. This property is OCPI-compliant.
logo • OCPIImage
Image link to an operator’s logo. This property is OCPI-compliant.
url • String
URL from where the image data can be fetched through a web browser. This property is OCPI-compliant.
thumbnail • String
URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant.
category • OCPIImageCategory
Category of an image. This property is OCPI-compliant.
Show OCPIImageCategory enum values
CHARGER
Photo of the physical device that contains one or more EVSEs.
ENTRANCE
Location entrance photo. Should show the car entrance to the location from street side.
LOCATION
Location overview photo.
NETWORK
Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATOR
Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present.
OTHER
Other
OWNER
Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.
type • String
Image type: gif, jpeg, png, svg. This property is OCPI-compliant.
width • Int
Width of the full scale image. This property is OCPI-compliant.
height • Int
Height of the full scale image. This property is OCPI-compliant.
country • String
Deprecated
ISO-3166 alpha-2 country code an operator is active in.
countries • CountryCodeAlpha2
ISO-3166 alpha-2 country codes an operator is active in.
Show CountryCodeAlpha2 enum values
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
contact • Contact
Contact information.
phone • String
The phone number in international format.
email • String
The email address.
website • String
The absolute URL of the website.
facebook • String
The absolute URL of the facebook profile page.
twitter • String
The absolute URL of the twitter profile page.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
ranking • Int
Ranking level on which the operator is placed or null in case the operator is not on any ranking level.
excluded • Boolean
Flag which indicates if the operator is in the excluded list.
suboperator • Operator
Information about a suboperator if applicable. This property is OCPI-compliant.
id • ID
Unique operator ID.
external_id • String
External ID of an operator provided by the operator data source.
name • String
Name of an operator. This property is OCPI-compliant.
website • String
Link to an operator’s website. This property is OCPI-compliant.
logo • OCPIImage
Image link to an operator’s logo. This property is OCPI-compliant.
url • String
URL from where the image data can be fetched through a web browser. This property is OCPI-compliant.
thumbnail • String
URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant.
category • OCPIImageCategory
Category of an image. This property is OCPI-compliant.
Show OCPIImageCategory enum values
CHARGER
Photo of the physical device that contains one or more EVSEs.
ENTRANCE
Location entrance photo. Should show the car entrance to the location from street side.
LOCATION
Location overview photo.
NETWORK
Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATOR
Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present.
OTHER
Other
OWNER
Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.
type • String
Image type: gif, jpeg, png, svg. This property is OCPI-compliant.
width • Int
Width of the full scale image. This property is OCPI-compliant.
height • Int
Height of the full scale image. This property is OCPI-compliant.
country • String
Deprecated
ISO-3166 alpha-2 country code an operator is active in.
countries • CountryCodeAlpha2
ISO-3166 alpha-2 country codes an operator is active in.
Show CountryCodeAlpha2 enum values
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
contact • Contact
Contact information.
phone • String
The phone number in international format.
email • String
The email address.
website • String
The absolute URL of the website.
facebook • String
The absolute URL of the facebook profile page.
twitter • String
The absolute URL of the twitter profile page.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
ranking • Int
Ranking level on which the operator is placed or null in case the operator is not on any ranking level.
excluded • Boolean
Flag which indicates if the operator is in the excluded list.
owner • Operator
Information about an owner if available. This property is OCPI-compliant.
id • ID
Unique operator ID.
external_id • String
External ID of an operator provided by the operator data source.
name • String
Name of an operator. This property is OCPI-compliant.
website • String
Link to an operator’s website. This property is OCPI-compliant.
logo • OCPIImage
Image link to an operator’s logo. This property is OCPI-compliant.
url • String
URL from where the image data can be fetched through a web browser. This property is OCPI-compliant.
thumbnail • String
URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant.
category • OCPIImageCategory
Category of an image. This property is OCPI-compliant.
Show OCPIImageCategory enum values
CHARGER
Photo of the physical device that contains one or more EVSEs.
ENTRANCE
Location entrance photo. Should show the car entrance to the location from street side.
LOCATION
Location overview photo.
NETWORK
Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATOR
Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present.
OTHER
Other
OWNER
Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.
type • String
Image type: gif, jpeg, png, svg. This property is OCPI-compliant.
width • Int
Width of the full scale image. This property is OCPI-compliant.
height • Int
Height of the full scale image. This property is OCPI-compliant.
country • String
Deprecated
ISO-3166 alpha-2 country code an operator is active in.
countries • CountryCodeAlpha2
ISO-3166 alpha-2 country codes an operator is active in.
Show CountryCodeAlpha2 enum values
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
contact • Contact
Contact information.
phone • String
The phone number in international format.
email • String
The email address.
website • String
The absolute URL of the website.
facebook • String
The absolute URL of the facebook profile page.
twitter • String
The absolute URL of the twitter profile page.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
ranking • Int
Ranking level on which the operator is placed or null in case the operator is not on any ranking level.
excluded • Boolean
Flag which indicates if the operator is in the excluded list.
facilities • OCPIFacility
Facilities a charging station belongs to. This property is OCPI-compliant.
Show OCPIFacility enum values
HOTEL
A hotel.
RESTAURANT
A restaurant.
CAFE
A cafe.
MALL
A mall or shopping center.
SUPERMARKET
A supermarket.
SPORT
Sport facilities: gym, field etc.
RECREATION_AREA
A recreation area.
NATURE
Located in, or close to, a park, nature reserve etc.
MUSEUM
A museum.
BIKE_SHARING
A bike/e-bike/e-scooter sharing location.
BUS_STOP
A bus stop.
TAXI_STAND
A taxi stand.
TRAM_STOP
A tram stop/station.
METRO_STATION
A metro station.
TRAIN_STATION
A train station.
AIRPORT
An airport.
PARKING_LOT
A parking lot.
CARPOOL_PARKING
A carpool parking.
FUEL_STATION
A Fuel station.
WIFI
Wifi or other type of internet available.
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.
twentyfourseven • Boolean
True to represent 24 hours a day and 7 days a week, except the given exceptions. This property is OCPI-compliant.
regular_hours • OCPIRegularHours
Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object. This property is OCPI-compliant.
weekday • Int
Number of days in the week, from Monday (1) till Sunday (7). This property is OCPI-compliant.
period_begin • String
Begin of the regular period, in local time, given in hours and minutes. Must be in 24h format with leading zeros. Example: "18:15". Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. This property is OCPI-compliant.
period_end • String
End of the regular period, in local time, syntax as for period_begin. Must be later than period_begin. This property is OCPI-compliant.
exceptional_openings • OCPIExceptionalPeriod
Exceptions for specified calendar dates, time-range based. Periods the station is operating/accessible. Additional to regular_hours. May overlap regular rules. This property is OCPI-compliant.
period_begin • DateTime
Begin of the exception. In UTC, time_zone field can be used to convert to local time. This property is OCPI-compliant.
period_end • DateTime
End of the exception. In UTC, time_zone field can be used to convert to local time. This property is OCPI-compliant.
exceptional_closings • OCPIExceptionalPeriod
Exceptions for specified calendar dates, time-range based. Periods the station is not operating/accessible. Overwriting regular_hours and exceptional_openings. Should not overlap exceptional_openings. This property is OCPI-compliant.
period_begin • DateTime
Begin of the exception. In UTC, time_zone field can be used to convert to local time. This property is OCPI-compliant.
period_end • DateTime
End of the exception. In UTC, time_zone field can be used to convert to local time. 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.
url • String
URL from where the image data can be fetched through a web browser. This property is OCPI-compliant.
thumbnail • String
URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant.
category • OCPIImageCategory
Category of an image. This property is OCPI-compliant.
Show OCPIImageCategory enum values
CHARGER
Photo of the physical device that contains one or more EVSEs.
ENTRANCE
Location entrance photo. Should show the car entrance to the location from street side.
LOCATION
Location overview photo.
NETWORK
Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATOR
Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present.
OTHER
Other
OWNER
Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.
type • String
Image type: gif, jpeg, png, svg. This property is OCPI-compliant.
width • Int
Width of the full scale image. This property is OCPI-compliant.
height • Int
Height of the full scale image. This property is OCPI-compliant.
energy_mix • OCPIEnergyMix
Details of the energy supplied at a location. This property is OCPI-compliant.
is_green_energy • Boolean
True if the power is 100% from regenerative sources. This property is OCPI-compliant.
energy_sources • OCPIEnergySource
Key-value pairs (enum + percentage) of energy sources of this location’s tariff. This property is OCPI-compliant.
source • OCPIEnergySourceCategory
The type of energy source. This property is OCPI-compliant.
Show OCPIEnergySourceCategory enum values
NUCLEAR
Nuclear power sources.
GENERAL_FOSSIL
All kinds of fossil power sources.
COAL
Fossil power from coal.
GAS
Fossil power from gas.
GENERAL_GREEN
All kinds of regenerative power sources.
SOLAR
Regenerative power from PV.
WIND
Regenerative power from wind turbines.
WATER
Regenerative power from water turbines.
percentage • Int
Percentage of this source (0-100) in the mix. This property is OCPI-compliant.
environ_impact • OCPIEnvironmentalImpact
Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location’s tariff. This property is OCPI-compliant.
category • OCPIEnvironmentalImpactCategory
The environmental impact category of this value. This property is OCPI-compliant.
Show OCPIEnvironmentalImpactCategory enum values
NUCLEAR_WASTE
Produced nuclear waste in g/kWh.
CARBON_DIOXIDE
Exhausted carbon dioxide in g/kWh.
amount • Float
Amount of this portion in g/kWh. This property is OCPI-compliant.
supplier_name • String
Name of the energy supplier, delivering the energy for this location or tariff.*. This property is OCPI-compliant.
energy_product_name • String
Name of the energy suppliers product/tariff plan used at this 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.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
elevation • Int
Elevation (altitude) level.
chargers • Charger
Groups of EVSEs by power and type.
standard • ConnectorType
Type of a charger.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
power • Float
Power of a charger, in kW.
price • String
Price of a charger.
speed • StationSpeedType
Charging speed.
Show StationSpeedType enum values
slow
Slow charging (below 43 kW).
fast
Fast charging stations (above 43 kW and below 150 kW).
turbo
Ultra fast charging stations (above 150 kW).
status • ChargerStatuses
Statuses of all the EVSEs grouped in a charger.
free • Int
How many are free.
busy • Int
How many are busy.
unknown • Int
How many are unknown.
error • Int
How many are not available.
total • Int
Total number of EVSEs grouped in a charger.
amenities • JSON
Amenities located at this location.
physical_address • Address
Enriched information about the physical address of a station.
continent • String
Continent code (2 letters).
country • String
Country code (2 letters).
county • String
County code (2 letters).
state_province • String
State or province.
municipality • String
Municipality.
city • String
City.
street • String
Street name.
number • String
Street number.
postalCode • String
Deprecated
Postal code of the location.
what3Words • String
Deprecated
String composed of 3 words which represent the location of an address on the globe. More details: http://w3w.co/.
formattedAddress • String
Deprecated
Human-readable address of the location.
postal_code • String
Postal code of the location.
what_3_words • String
String composed of 3 words which represent the location of an address on the globe. More details: http://w3w.co/.
formatted_address • String
Human-readable address of the location.
heavy_vehicles_properties • StationHeavyVehiclesProperties
Describes the heavy vehicle properties at the location.
is_dedicated • Boolean
Indicates whether the location was constructed mainly for the purpose of heavy vehicles like trucks.
facilities • HeavyVehiclesFacility
List of facilities in the location.
Show HeavyVehiclesFacility enum values
TRUCK_PARKING
Truck parking.
TRUCK_WASH
Truck wash.
TRUCK_REPAIR
Truck repair.
TRUCK_DEALERSHIP
Truck dealership.
SECURE_TRUCK_PARKING
Secure truck parking.
is_trailer_accessible • Boolean
Indicates whether the location is suitable for trucks with trailers.
is_drive_through • Boolean
Indicates whether the location is drive-through.
allows_dangerous_goods • Boolean
Indicates whether the location allows charging of heavy vehicles transporting dangerous goods.
allows_rigid_vehicles • Boolean
Indicates whether the location is suitable for rigid heavy vehicles.
allows_overnight_parking • Boolean
Indicates whether the location allows overnight charging of heavy vehicles.
heavy_vehicles_restrictions • StationHeavyVehiclesRestrictions
Describes the heavy vehicle restrictions at the location.
height • Float
Maximum height of the heavy vehicle that is allowed to be parked at the charging station.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
width • Float
Maximum width of the heavy vehicle that is allowed to be parked at the charging station.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
length • Float
Maximum length of the heavy vehicle that is allowed to be parked at the charging station.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
mass • Float
Maximum mass of the heavy vehicle that is allowed to be parked at the charging station.
Show arguments
unit • WeightUnit
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
allowed_types_EU • HeavyVehiclesEUType
Allowed N (EU) types of heavy vehicles.
Show HeavyVehiclesEUType enum values
N1
Only N1 type of heavy vehicles can be parked at the charging station. N1 vehicles have a maximum mass not exceeding 3.5 tonnes (7,700 lbs).
N2
Only N2 type of heavy vehicles can be parked at the charging station. N2 vehicles have a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes (26,000 lbs).
N3
Only N3 type of heavy vehicles can be parked at the charging station. N3 vehicles have a maximum mass exceeding 12 tonnes (26,000 lbs).
vehicle_restrictions • StationVehicleRestrictions
Describes the vehicle restrictions at the location.
mass • Float
Maximum weight for a vehicle that is allowed at the location.
Show arguments
unit • WeightUnit
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
width • Float
Maximum width for a vehicle that is allowed at the location.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
height • Float
Maximum height for a vehicle that is allowed at the location.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
length • Float
Maximum length for a vehicle that is allowed at the location.
Show arguments
unit • DimensionUnit
Default • meter
Show DimensionUnit enum values
meter
Return the dimension in meters.
foot
Return the dimension in feet.
kilometer
Return the dimension in kilometers.
mile
Return the dimension in miles.
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.
latitude • String
Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}. This property is OCPI-compliant.
longitude • String
Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}. This property is OCPI-compliant.
name • OCPIDisplayText
Name of the point in local language or as written at the location. For example the street name of a parking lot entrance or it’s number. This property is OCPI-compliant.
language • String
Language Code ISO 639-1. This property is OCPI-compliant.
text • String
Text to be displayed to an end user. No markup, html etc. allowed. This property is OCPI-compliant.
properties • JSON
Deprecated
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.
weekday • Int
Number of weekday from 1 (monday) to 7 (sunday).
prediction • Int
The prediction for each hour 0-23 from 1 to 5 (1 - very busy ... 5 very quiet (free)).
predicted_occupancy • StationPredictedOccupancy
Predicted station occupancy.
weekday • Int
Number of weekday from 1 (monday) to 7 (sunday).
occupancy • Int
Occupancy on a scale from 1 to 10, where 1 means free for charging and 10 means fully occupied.
period_begin • String
Start of the period of the occupancy prediction (string of 'hh-mmZ' format).
period_end • String
End of the period of the occupancy prediction (string of 'hh-mmZ' format).
speed • StationSpeedType
Charging speed for a station.
Show StationSpeedType enum values
slow
Slow charging (below 43 kW).
fast
Fast charging stations (above 43 kW and below 150 kW).
turbo
Ultra fast charging stations (above 150 kW).
status • ChargerStatus
Global status for a station.
Show ChargerStatus enum values
free
The charger is free.
busy
The charger is occupied/busy.
unknown
The charger is unknown.
error
The charger has an error.
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.
roaming • StationRoaming
Deprecated
List of eMSP cards accepted at a charging station.
partner_id • String
Unique id for a provider. It is created by Eco-Movement, and it is stable.
ema_id • String
Unique E-Mobility Account Identifier (eMA ID) for a provider. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the provider. For example, NL-ECO. Note: A provider can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and owns the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ['NL-EXA', 'NL-EXB'].
emsp • String
Name of the EMSP provider.
card • String
Name of the card accepted at a charging station.
android_app_link • String
Link to native Android app for card accepted at a charging station.
ios_app_link • String
Link to native iOS app for card accepted at a charging station.
support_phone_number • String
Deprecated
Phone number for assistance at a charging station.
charging_behaviour • ChargingBehaviour
Deprecated
Charging behavior of a station.
code • ChargingBehaviourCode
Charging behaviour of users divided in groups, based on real-time information.
Show ChargingBehaviourCode enum values
URBAN_CHARGING
Mainly morning charging, and some mixed afternoon and evening charging.
FAST_CHARGING
Mainly fast charging, with some morning and afternoon charging.
MIXED_CHARGING
Mixed behaviour between morning, afternoon, evening, overnight, and noise charging.
NOISE_CHARGING
Mainly noise charging.
OVERNIGHT_CHARGING
Mainly overnight charging.
OFFICE_CHARGING
Mainly morning charging, with some afternoon charging.
description • String
Description of charging behaviour.
reliability_score • Int
Deprecated
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_method • AdhocAuthorisationMethod
Deprecated
List of available ad hoc payment methods.
Show AdhocAuthorisationMethod enum values
CREDIT_CARD
DEBIT_CARD
OTHER
OTHER_Apple_Pay
OTHER_Authentication_by_car
OTHER_Google_Pay
QR_CODE
SMS
predicted_occupancy • StationPredictedOccupancy
Deprecated
Predicted station occupancy.
weekday • Int
Number of weekday from 1 (monday) to 7 (sunday).
occupancy • Int
Occupancy on a scale from 1 to 10, where 1 means free for charging and 10 means fully occupied.
period_begin • String
Start of the period of the occupancy prediction (string of 'hh-mmZ' format).
period_end • String
End of the period of the occupancy prediction (string of 'hh-mmZ' format).
access_type • AccessType
Deprecated
Type of access to the charging station.
Show AccessType enum values
Public
Restricted
Private
oicp • OICPStationCustomProperties
Custom station properties for OICP databases such as the global Hubject database. Station databases that not follow the OICP standard return null values.
parking_facility • Boolean
Returns whether the station is a parking facility.
parking_spot • String
Returns an identifier for the precise parking spot. Eg. 36 or 12-1.
calibration_law_data_availability • String
Returns information on how the charging station provides metering law data.
clearinghouse_id • String
Identification of the corresponding clearing house in the event that roaming between different clearing houses must be processed in the future.
review • ReviewStats
Review of a station.
rating • Float
Average of all reviews.
count • Int
'Total number of reviews.
roaming • StationRoaming
List of eMSP cards accepted at a charging station.
partner_id • String
Unique id for a provider. It is created by Eco-Movement, and it is stable.
ema_id • String
Unique E-Mobility Account Identifier (eMA ID) for a provider. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the provider. For example, NL-ECO. Note: A provider can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and owns the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ['NL-EXA', 'NL-EXB'].
emsp • String
Name of the EMSP provider.
card • String
Name of the card accepted at a charging station.
android_app_link • String
Link to native Android app for card accepted at a charging station.
ios_app_link • String
Link to native iOS app for card 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.
code • ChargingBehaviourCode
Charging behaviour of users divided in groups, based on real-time information.
Show ChargingBehaviourCode enum values
URBAN_CHARGING
Mainly morning charging, and some mixed afternoon and evening charging.
FAST_CHARGING
Mainly fast charging, with some morning and afternoon charging.
MIXED_CHARGING
Mixed behaviour between morning, afternoon, evening, overnight, and noise charging.
NOISE_CHARGING
Mainly noise charging.
OVERNIGHT_CHARGING
Mainly overnight charging.
OFFICE_CHARGING
Mainly morning charging, with some afternoon charging.
description • String
Description of charging behaviour.
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
AUTH_BY_CAR_PLUG_AND_CHARGE
Authentication by car through Plug and Charge.
ONLINE_APPLE_PAY
Apple Pay.
TERMINAL_IN_APP
Terminal in app.
ONLINE_PAYPAL
PayPal.
SERVICE_PROVIDER_RFID_CARD
Service Provider RFID Card.
TERMINAL_QR_CODE
Terminal QR Code.
TERMINAL_CREDIT_CARD
Terminal Credit Card.
TERMINAL_DEBIT_CARD
Terminal Debit Card.
TERMINAL_SMS
Terminal SMS.
ONLINE_CREDIT_CARD
Credit Card.
OTHER_OTHER
Other.
TERMINAL_CONTACTLESS
Terminal Contactless.
ONLINE_GOOGLE_PAY
Google Pay.
ONLINE_BANK_PAYMENT
Bank Payment.
AUTH_BY_CAR_AUTOCHARGE
Authentication by car through Auto Charge.
access_type • AccessType
Type of access to the charging station.
Show AccessType enum values
Public
Restricted
Private
user • ReviewUser
User who added a review. If a review was added by an anonymous user, this will be null.
name • String
User full name. If a review was added by an anonymous user, this will be null.
id • ID
Deprecated
User ID.
firstName • String
Deprecated
First name.
lastName • String
Deprecated
Last name.
rating • Int
Rating of a review.
message • String
Message of a review.
locale • String
Locale of a message.
ev • Vehicle
Vehicle that was provided/selected by a user.
id • ID
Vehicles unique ID.
naming • VehicleNaming
Naming of the vehicle.
make • String
Vehicle manufacturer name.
model • String
Vehicle model name.
version • String
Version, edition or submodel of the vehicle.
edition • String
Another submodel level of the vehicle.
chargetrip_version • String
Vehicle model version. Added by Chargetrip as an alternative for when a vehicle manufacturer does not provide an version name, or uses the same version name across all trims or consecutive years.
drivetrain • VehicleDrivetrain
Drivetrain of the vehicle.
type • VehicleDrivetrainType
Type of drivetrain.
Show VehicleDrivetrainType enum values
BEV
Battery Electric Vehicle.
EREV
Extended Range Electric Vehicle.
HEV
Hybrid Electric Vehicle.
PHEV
Plug-in Hybrid Electric Vehicle.
connectors • VehicleConnector
Available connectors for the vehicle. Please note that for HEVs this will always be an empty array.
standard • ConnectorType
Connector type, known as connector standard in OCPI.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
power • Float
Usable electric power.
Show arguments
unit • PowerUnit
Default • kilowatt
Show PowerUnit enum values
kilowatt
Return the power in kilowatts.
horsepower
Return the power in horsepower.
max_electric_power • Float
Maximum electric power.
Show arguments
unit • PowerUnit
Default • kilowatt
Show PowerUnit enum values
kilowatt
Return the power in kilowatts.
horsepower
Return the power in horsepower.
time • Int
Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.
speed • Float
Deprecated
Charging speed.
Show arguments
unit • SpeedUnit
Default • kilometers_per_hour
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
charge_speed • Float
Charging speed.
Show arguments
unit • ChargeSpeedUnit
Default • kilometers_per_hour
Show ChargeSpeedUnit enum values
kilowatt_hour
Return the charge speed in kilowatt hours.
kilometers_per_hour
Return the charge speed in kilometers per hour.
miles_per_hour
Return the charge speed in miles per hour.
adapters • VehicleConnector
Adapters for the connectors of the vehicle. Please note that for HEVs this will always be an empty array.
standard • ConnectorType
Connector type, known as connector standard in OCPI.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
power • Float
Usable electric power.
Show arguments
unit • PowerUnit
Default • kilowatt
Show PowerUnit enum values
kilowatt
Return the power in kilowatts.
horsepower
Return the power in horsepower.
max_electric_power • Float
Maximum electric power.
Show arguments
unit • PowerUnit
Default • kilowatt
Show PowerUnit enum values
kilowatt
Return the power in kilowatts.
horsepower
Return the power in horsepower.
time • Int
Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.
speed • Float
Deprecated
Charging speed.
Show arguments
unit • SpeedUnit
Default • kilometers_per_hour
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
charge_speed • Float
Charging speed.
Show arguments
unit • ChargeSpeedUnit
Default • kilometers_per_hour
Show ChargeSpeedUnit enum values
kilowatt_hour
Return the charge speed in kilowatt hours.
kilometers_per_hour
Return the charge speed in kilometers per hour.
miles_per_hour
Return the charge speed in miles per hour.
battery • VehicleBattery
Battery of the vehicle.
full_kwh • Float
Full battery capacity in kWh.
usable_kwh • Float
Usable battery capacity in kWh.
type • VehicleBatteryType
Type of battery.
Show VehicleBatteryType enum values
lithium_ion
Lithium-Ion Battery.
body • VehicleBody
Body of the vehicle.
width • Float
Width with folded mirrors.
Show arguments
unit • MeasurementUnit
Default • millimeter
Show MeasurementUnit enum values
millimeter
Return the measurement in millimeters.
inch
Return the measurement in inches.
height • Float
Height (average height for adjustable suspensions).
Show arguments
unit • MeasurementUnit
Default • millimeter
Show MeasurementUnit enum values
millimeter
Return the measurement in millimeters.
inch
Return the measurement in inches.
weight • VehicleBodyWeight
Weight (unladen).
minimum • Float
Minimum weight.
Show arguments
unit • WeightUnit
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
nominal • Float
Nominal weight.
Show arguments
unit • WeightUnit
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
maximal • Float
Maximal weight.
Show arguments
unit • WeightUnit
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
seats • Int
Number of seats.
availability • VehicleAvailability
Availability of the vehicle.
status • VehicleAvailabilityStatus
Availability of the vehicle.
Show VehicleAvailabilityStatus enum values
no_longer_available
Vehicle no longer for sale in any market / region.
available
Vehicle currently for sale in at least one market / region.
release_date_announced_preorderable
Vehicle expected in market from Date_From (estimated), pre-order open.
release_date_announced
Vehicle expected in market from Date_From (estimated), pre-order unknown or not open.
concept_vehicle_preorderable
Concept vehicle, nearing production and/or confirmed, pre-order open.
concept_vehicle
Concept vehicle, nearing production and/or confirmed, pre-order unknown or not open.
concept_vehicle_release_date_tba_preorderable
Concept vehicle, not close to production and/or unconfirmed, pre-order open.
concept_vehicle_release_date_tba
Concept vehicle, not close to production and/or unconfirmed, pre-order unknown.
uncertain
Status uncertain, introduction date and/or pricing unclear.
performance • VehiclePerformance
Performance of the vehicle.
acceleration • Float
Acceleration.
Show arguments
unit • AccelerationUnit
Default • seconds_to_100_kilometers_per_hour
Show AccelerationUnit enum values
seconds_to_100_kilometers_per_hour
Return the acceleration in seconds to 100 kilometers per hour.
seconds_to_60_miles_per_hour
Return the acceleration in seconds to 60 miles per hour.
top_speed • Float
Top speed of the vehicle.
Show arguments
unit • SpeedUnit
Default • kilometers_per_hour
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
range • VehicleRange
Range of the vehicle.
provider • Float
Index range.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
provider_is_estimated • Boolean
Indicates if index range is estimated.
worst • VehicleRangeValue
Worst conditions are based on -10°C and use of heating.
highway • Float
Estimated value on the highway or express roads.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
city • Float
Estimated value on the cities road.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
combined • Float
Estimated combined value.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
best • VehicleRangeValue
Best conditions are based on 23°C and no use of A/C.
highway • Float
Estimated value on the highway or express roads.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
city • Float
Estimated value on the cities road.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
combined • Float
Estimated combined value.
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
chargetrip_range • ChargetripRange
Chargetrip's custom real-world range provides a carefully calculated display range for all-electric vehicle models. Chargetrip range is based on the theoretical distance driven using only the electric engine. Vehicles that do not have a full electric drivetrain type (all except Battery Electric Vehicles / BEV) therefore return relatively small ranges. More information on the CT range can be found at https://chargetrip.com/blog/what-is-ct-real-range
worst • Float
Range calculated using the worst conditions. Worst conditions are based on -0°C, including use of heating. More information on the CT range can be found at https://chargetrip.com/blog/what-is-ct-real-range
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
best • Float
Range calculated using the best conditions. Best conditions are based on 25°C, including use of A/C. More information on the CT range can be found at https://chargetrip.com/blog/what-is-ct-real-range
Show arguments
unit • DistanceUnit
Default • kilometer
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
media • VehicleMedia
Media of the vehicle.
image • VehicleImage
Featured image of the vehicle from a 45-degree angle.
id • ID
Image id.
type • VehicleImageType
Image type.
Show VehicleImageType enum values
provider
Images provided by a Vehicle Datasource.
image
Full-sized image at 1536x864 px.
image_thumbnail
Thumbnail of a full-sized image at 131x72 px.
image_premium
Premium image.
premium_image_thumbnail
Thumbnail of a premium image.
brand
Full-sized brand (make) logo at 768x432 px.
brand_thumbnail
Thumbnail of a full-sized brand (make) logo at 56x24 px.
placeholder
Placeholder image at 1536x864 px.
url • String
Full path URL of a large image.
height • Int
Height of a large image in pixels.
width • Int
Width of a large image in pixels.
thumbnail_url • String
Full path URL of a thumbnail image.
thumbnail_height • Int
Height of a thumbnail image in pixels.
thumbnail_width • Int
Width of a thumbnail image in pixels.
brand • VehicleImage
Deprecated
Latest make logo.
id • ID
Image id.
type • VehicleImageType
Image type.
Show VehicleImageType enum values
provider
Images provided by a Vehicle Datasource.
image
Full-sized image at 1536x864 px.
image_thumbnail
Thumbnail of a full-sized image at 131x72 px.
image_premium
Premium image.
premium_image_thumbnail
Thumbnail of a premium image.
brand
Full-sized brand (make) logo at 768x432 px.
brand_thumbnail
Thumbnail of a full-sized brand (make) logo at 56x24 px.
placeholder
Placeholder image at 1536x864 px.
url • String
Full path URL of a large image.
height • Int
Height of a large image in pixels.
width • Int
Width of a large image in pixels.
thumbnail_url • String
Full path URL of a thumbnail image.
thumbnail_height • Int
Height of a thumbnail image in pixels.
thumbnail_width • Int
Width of a thumbnail image in pixels.
make • VehicleImage
Latest make logo.
id • ID
Image id.
type • VehicleImageType
Image type.
Show VehicleImageType enum values
provider
Images provided by a Vehicle Datasource.
image
Full-sized image at 1536x864 px.
image_thumbnail
Thumbnail of a full-sized image at 131x72 px.
image_premium
Premium image.
premium_image_thumbnail
Thumbnail of a premium image.
brand
Full-sized brand (make) logo at 768x432 px.
brand_thumbnail
Thumbnail of a full-sized brand (make) logo at 56x24 px.
placeholder
Placeholder image at 1536x864 px.
url • String
Full path URL of a large image.
height • Int
Height of a large image in pixels.
width • Int
Width of a large image in pixels.
thumbnail_url • String
Full path URL of a thumbnail image.
thumbnail_height • Int
Height of a thumbnail image in pixels.
thumbnail_width • Int
Width of a thumbnail image in pixels.
image_list • VehicleImage
All images of the vehicle.
id • ID
Image id.
type • VehicleImageType
Image type.
Show VehicleImageType enum values
provider
Images provided by a Vehicle Datasource.
image
Full-sized image at 1536x864 px.
image_thumbnail
Thumbnail of a full-sized image at 131x72 px.
image_premium
Premium image.
premium_image_thumbnail
Thumbnail of a premium image.
brand
Full-sized brand (make) logo at 768x432 px.
brand_thumbnail
Thumbnail of a full-sized brand (make) logo at 56x24 px.
placeholder
Placeholder image at 1536x864 px.
url • String
Full path URL of a large image.
height • Int
Height of a large image in pixels.
width • Int
Width of a large image in pixels.
thumbnail_url • String
Full path URL of a thumbnail image.
thumbnail_height • Int
Height of a thumbnail image in pixels.
thumbnail_width • Int
Width of a thumbnail image in pixels.
video • VehicleVideo
Latest video.
id • ID
Video id.
url • String
Full path URL of a video.
video_list • VehicleVideo
All videos of the vehicle.
id • ID
Video id.
url • String
Full path URL of a video.
routing • VehicleRouting
Routing of the vehicle.
fast_charging_support • Boolean
Vehicles that support fast charging have a minimum charging speed of 43 kWh.
connect • Connect
Information about vehicle connectivity.
providers • ConnectProvider
List of connectivity providers to which the vehicle can connect. This field returns null for free users. Please contact customer success for more information.
Show ConnectProvider enum values
Enode
region • VehicleRegion
Regions in which the vehicle is available. Based on the continent code (CC) standard.
Show VehicleRegion enum values
AF
Africa.
AS
Asia.
EU
Europe.
NA
North America.
OC
Oceania.
SA
South America.
purpose • VehiclePurpose
Vehicle intended use. Can be passenger, cargo, or utility.
Show VehiclePurpose enum values
passenger
Vehicle intended for the transportation of passengers.
cargo
Vehicle intended for the transportation of cargo.
utility
Vehicle intended for the transportation of everything except cargo or passengers. Eg: ambulances, agricultural vehicles, etcetera.
type • VehicleType
Type of vehicle.
Show VehicleType enum values
motorcycle
Any motor vehicle with two wheels or a motor vehicle with no more than four wheels, does not have parallel seating, and is controlled by means of handlebars.
microcar
A motor vehicle with three or four wheels that is not a Motorcycle, Pickup, Van, Truck, or Utility vehicle and either has a top speed of less than 60kph or an unladen weight of less than 400kg.
car
A motor vehicle that does not have an enclosed cab, is not a microcar or utility vehicle, is capable of carrying eight or fewer people, and that has less than one third of its internal volume dedicated to cargo, living, or sleeping space in its default configuration.
pickup
A motor vehicle that has an enclosed cab, is not a utility vehicle, and has a fixed, non-articulated, open-top back cargo bed that is enclosed on at least three sides.
van
A motor vehicle that does not have an enclosed cab, is not a utility vehicle, that fulfills exactly one of the following conditions:
- It is capable of carrying more than eight but less than twenty people.
- At least one third of its internal volume is dedicated to cargo space in its default configuration.
- It is the passenger variant of a vehicle that meets criterion 2.
bus
A motor vehicle that does not have an enclosed cab, is not a Utility vehicle, and is capable of carrying 20 or more people in its default configuration.
truck
A motor vehicle that has an enclosed cab and is not a Pickup or Utility vehicle.
utility
A motor vehicle that fulfills at least one of the following conditions:
- It does not have wheels.
- It has some mode of locomotion other than wheels in its default configuration such as treads, skis, or floats.
- It is capable of air or water travel in its default configuration.
- It was manufactured primarily for some purpose other than transporting cargo or passengers.
- It does not conform to any of the criteria for the other vehicle categories.
heat_pump • VehicleHeatPump
Details about Heat Pump.
is_available • Boolean
Indicates if a heat pump is available for a specific vehicle.
is_standard_equipment • Boolean
Indicates if a heat pump is standard equipment for a specific vehicle.
plugType • ConnectorType
Plug type that was provided/selected by a user.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
tags • ReviewTags
Boolean tags for a station review.
working • Boolean
Flag which indicates if the station was working when the review was added.
recommended • Boolean
Flag which indicates if the user recommended the station when the review was added.
createdAt • String
Date and time when a review was created.
updatedAt • String
Date and time when a review was updated.
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.
Error
CAR_NOT_FOUND
No car was found with the provided ID.
Error
CLIENT_AUTH_MANDATORY
This feature requires authorization. Please contact support for more details!
Error
ERROR_FORBIDDEN_MESSAGE
You are forbidden to execute this operation.
Error
MISSING_REQUIRED_PARAMETERS
Missing required parameter(s): $PARAMETERS.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
Error
REVIEW_MESSAGE_LENGTH_EXCEEDED
The message provided is too long. The maximum number of characters is 10000.
Error
REVIEW_RATING_NOT_IN_RANGE
The rating provided is not valid. The value must be between 0 and 5.