Query route details
After you received your route ID through the route mutation, you can query your route details. These route details will contain everything from a polyline to charge stations, ideal for plotting a route on a map or providing turn-by-turn instructions. If you need more details for your specific route, see query route path.
Render route and route data
Plot a route on a map and render the route detail data.
Query
To query the route details you will need to configure it with the route ID. Be sure to include the status in your response and check it. If your route hasn't completed processing yet, then your route details will not be available. To prevent this from happening you can use the subscription service.
If you also supported additional route options in the route mutation you will now be able to collect the details. Below you can find instructions on how to do that.
Pricing
To render pricing when using the Eco-Movement station database, you can use pricing to fetch a list of prices on the connector level. The pricing field is available on evse.connectors. The pricing list includes CPO and MSP prices. The "adhoc price" is the CPO price.
When using any other station database, use the tariff query and tariff details query.
Route steps
Every leg of the route includes the steps property. These steps allow you to easily identify different road characteristics and highlight them in your application. The type of route steps are: road, highway, ferry, toll, and crossborder. Every step includes the distance, duration, consumption and a separate polyline. If you want to know what type of road characteristics there are on your entire journey you can include the tags property in your route request.
Support alternative stations along a route
If your route mutation included the stationsAlongRouteRadius with a valid distance, you can now request the station details in this query. To do so, you will need to add the stationsAlongRoute field with its appropriate children.
Support stations as waypoint
If your route mutation included stations in the via parameter, you will receive a route with additional stations as waypoints. These station as waypoints can be found inside the route.leg.
Get additional properties
Our route destination, origin and stations have an optional properties attribute in any of our route queries. You can use this to fetch a complete address, the current temperature (temp) and air pressure at that location.
Arguments
id • ID
• Required
Frequently used fields
route • RouteAlternative
Recommended route.
id • ID
ID of a route alternative.
type • RouteAlternativeType
Type of alternative route.
Show RouteAlternativeType enum values
fastest
Fastest route between origin and destination.
bestMatching
Best matching route based on operator and amenities preferences.
alternative
An alternative to the fastest route.
charges • Int
Number of charges along a route.
chargesAvailable • Int
Number of available charges along a route.
chargesOccupied • Int
Number of occupied charges along a route.
chargesUnknown • Int
Number of unknown charges along a route.
chargesOutOfOrder • Int
Number of out of order charges along a route.
distance • Int
Total distance of a route in meters.
duration • Int
Total duration of a route, including charge time, in seconds.
consumption • Float
Total energy used for a route in kWh.
chargeTime • Float
Total time required to charge for an entire route, in seconds.
amenityRanking • Int
Deprecated
Amenity ranking for an alternative.
rangeStart • Int
Display value that indicates the range, in meters, available at the beginning of the trip. This range is calculated using the Chargetrip range, the conditions at the time of planning the route, weather scenario (current or seasonal) and the route input.
rangeStartKwh • Float
Total energy in a battery at the beginning of a trip, in kWh.
rangeStartPercentage • Int
Total energy in a battery at the beginning of a trip, in percentage.
rangeEnd • Int
Display value that indicates the range, in meters, available at the end of the trip. This range is calculated using the Chargetrip range, the conditions at the time of planning the route, weather scenario (current or seasonal) and the route input. Please note: In case of a non BEV where the range end is negative, the value will be 0.
rangeEndKwh • Float
Remaining range, energy in kWh, at the end of a trip. In the case of a non BEV where the range end is negative, the value will be 0.
rangeEndPercentage • Int
Remaining range, energy in percentage, at the end of a trip.
via • String
Text information about a route direction.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • Int
Number of decimals used by the algorithm to encode [long, lat] pairs. Allowed values are 5 or 6.
Default • 5
pathPlot • PathSegment
Path elevation, distance, duration, consumption and speed values, grouped into 100 segments.
elevation • Int
Elevation (altitude) in meters.
averageSpeed • Float
Average speed, in km/h, for this route path segment.
consumption • Float
Consumption, in kWh, of a route path segment.
consumptionPerKm • Float
Consumption, in kWh per km, of a route path segment.
distance • Float
Distance, in meters, of a route path segment.
duration • Float
Duration, in seconds, of a route path segment.
stateOfCharge • Float
State of charge, in kWh, of a route path segment.
elevationPlot • Float
Deprecated
Elevation values. Each elevationPlot has a hundred points, independent of the length of a route.
elevationUp • Float
Total number of meters which are going up on a route.
elevationDown • Float
Total number of meters which are going down on a route.
elevationMax • Float
Highest value from the elevation array.
saving • RouteAlternativeSaving
Money and CO2 saving information.
co2 • String
Total amount of CO2, in grams, which would be used with a gasoline vehicle.
money • String
Money saved by a user driving this route with the electric vehicle.
currency • String
Currency.
averageGasPrice • String
Average gas price with which the calculation was made.
averageEnergyPrice • String
Average energy price with which the calculation was made.
legs • RouteLeg
Legs of the route.
id • ID
ID of a leg.
distance • Int
Distance from the start to the end of a leg, in meters.
duration • Int
Total drive time from the start to the end of a leg, in seconds.
consumption • Float
Total energy used in a leg in kWh.
rangeStart • Int
Display value that indicates the range, in meters, available at the beginning of the leg. This range is calculated using the Chargetrip range, the conditions at the time of planning the route, weather scenario (current or seasonal) and the route input.
rangeStartKwh • Float
Total energy in a battery at the beginning of a leg, in kWh.
rangeStartPercentage • Int
Total energy in a battery at the beginning of a trip, in percentage.
rangeEnd • Int
Display value that indicates the range, in meters, available at the end of the leg. This range is calculated using the Chargetrip range, the conditions at the time of planning the route, weather scenario (current or seasonal) and the route input. Please note: In case of a non BEV where the range end is negative, the value will be 0.
rangeEndKwh • Float
Total energy left in a battery at the end of a leg, in kWh. In the case of a non BEV where the range end is negative, the value will be 0.
rangeEndPercentage • Int
Remaining range, energy in percentage, at the end of a trip.
origin • FeaturePoint
Origin point location.
id • String
Feature ID.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
destination • FeaturePoint
Destination point location.
id • String
Feature ID.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • JSON
Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
type • LegType
Type of a leg.
Show LegType enum values
station
This leg ends at a charging station and the vehicle must recharge.
stationVia
This leg ends at a via charging station and the vehicle must recharge.
stationAmenity
This leg ends at a scheduled charging station and the vehicle must recharge.
via
This leg ends at a via location.
final
This leg ends at the destination, and is the last leg of the route.
stationFinal
This leg ends at the destination which is a charging station, and is the last leg of the route.
name • String
Name of a destination. This is the station name in case a user should charge or the name of the location in case this was provided.
stationId • String
ID of a station.
operatorId • String
ID of an operator.
operatorName • String
Name of an operator.
operatorRanking • Int
Ranking of an operator.
chargeTime • Int
Total time required to charge a battery until 80%, in seconds.
evse • EVSE
Recommended EVSE where to charge.
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
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.
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.
connector • Connector
Recommended connector for charging.
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
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.
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
plugsAvailable • Int
Number of compatible plugs available at a charge station.
plugsOccupied • Int
Number of compatible plugs occupied at a charge station.
plugsUnknown • Int
Number of compatible plugs unknown at a charge station.
plugsOutOfOrder • Int
Number of compatible plugs out of order at a charge station.
plugsCount • Int
Total number of compatible plugs at a charge station.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • Int
Number of decimals used by the algorithm to encode [long, lat] pairs. Allowed values are 5 or 6.
Default • 5
steps • RouteStep