Provides buyers and users with real world charging performance data that factors in expected losses during home charging.
Key Features
Charge Port Type
The type of standard charge port (e.g. Type 2)
Charge Port Location
The location of the standard charge port on the vehicle
Maximum Power
The maximum power capability of the standard onboard charger
Average Power
The average power once expected losses are factored in (used to determine real world performance)
Charge Performance Data
Provides the real world charge time (mins) and charge speed (mph) in a range of domestic charging scenarios
Optional Charger Data
Provides the same in-depth data for any optional chargers available
Sample Response
V1
Documentation
Introduction
This endpoint returns accurate, real world home charging times for different electric supply equipment.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/evdatabase/uk/car/onboardcharging/?evdb_vehicle_id=1234
Example Sandbox Request
https://sandbox.oneautoapi.com/evdatabase/uk/car/onboardcharging/?evdb_vehicle_id=1234
Request Parameters
evdb_vehicle_id
mandatory, string, e.g. 1234
EV Database Vehicle ID
Sample Response
{
"success": true,
"result": {
"charge_port_type": "Type 2",
"is_charge_port_type_estimated": false,
"charge_port_location": "Left Side - Front",
"additional_charge_port_location": "Right Side - Front",
"is_additional_charge_port_optional": true,
"standard_onboard_charger_max_power_kw": 11,
"standard_onboard_charger_number_phases": 3,
"standard_onboard_charger_max_current_amps": 16,
"standard_onboard_charger_chargetime_0to100_percent_minutes": 540,
"standard_onboard_charge_chargespeed_mph": 16.77702213,
"standard_onboard_charger_table": [
{
"electric_vehicle_supply_equipment_voltage": 230,
"charger_max_chargespeed_mph": 3.7282271399999996,
"electric_vehicle_supply_equipment_phase_number": 1,
"charger_chargetime_0to100_mins": 2580,
"electric_vehicle_supply_equipment_power_kw": 2.3,
"charger_charge_volts": 230,
"charger_charge_phase": 1,
"electric_vehicle_supply_equipment_desc": "230V10A1X",
"electric_vehicle_supply_equipment_current_amps": 10,
"charger_charge_power_kw": 2.3,
"charger_charge_amps": 10
}
],
"is_standard_onboard_charger_data_estimated": false,
"optional_onboard_charger_max_power_kw": 22,
"optional_onboard_charger_number_phases": 3,
"optional_onboard_charger_max_current_amps": 32,
"optional_onboard_charger_chargetime_0to100_percent_minutes": 270,
"optional_onboard_charge_chargespeed_mph": 33.55404426,
"optional_onboard_charger_table": [
{
"electric_vehicle_supply_equipment_voltage": 230,
"charger_max_chargespeed_mph": 3.7282271399999996,
"electric_vehicle_supply_equipment_phase_number": 1,
"charger_chargetime_0to100_mins": 2580,
"electric_vehicle_supply_equipment_power_kw": 2.3,
"charger_charge_volts": 230,
"charger_charge_phase": 1,
"electric_vehicle_supply_equipment_desc": "230V10A1X",
"electric_vehicle_supply_equipment_current_amps": 10,
"charger_charge_power_kw": 2.3,
"charger_charge_amps": 10
}
]
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
charge_port_type
e.g. Type 2
Type of port for this charge port item.
is_charge_port_type_estimated
e.g. false
Is the charge port type estimated.
charge_port_location
e.g. Left Side - Front
Position on the vehicle of this charge port item.
additional_charge_port_location
e.g. Right Side - Front
Additional charge port location
is_additional_charge_port_optional
e.g. true
Is an additional charge port optional.
standard_onboard_charger_max_power_kw
e.g. 11
Maximum power the onboard charger can accept to charge the battery.
standard_onboard_charger_number_phases
e.g. 3
Number of phases the onboard charger can accept to achieve max power.
standard_onboard_charger_max_current_amps
e.g. 16
Maximum current the onboard charger accepts per phase to achieve max power
standard_onboard_charger_chargetime_0to100_percent_minutes
e.g. 540
Standard onboard chargetime 0 to 100% in minutes.
standard_onboard_charge_chargespeed_mph
e.g. 16.77702213
Standard onboard charge speed miles per hour.
electric_vehicle_supply_equipment_voltage
e.g. 230
Electric vehicle supply equipment voltage.
charger_max_chargespeed_mph
e.g. 3.7282271399999996
Onboard charger maximum charge speed in mph.
electric_vehicle_supply_equipment_phase_number
e.g. 1
Electric vehicle supply equipment phase number.
charger_chargetime_0to100_mins
e.g. 2580
Onboard charger chargetime 1 to 100% in minutes.
electric_vehicle_supply_equipment_power_kw
e.g. 2.3
Rate of the power delivery in kilowatts.
charger_charge_volts
e.g. 230
Onboard charger charge volts
charger_charge_phase
e.g. 1
Number of onboard charger phases.
electric_vehicle_supply_equipment_desc
e.g. 230V10A1X
Electric vehicle supply equipment description.
electric_vehicle_supply_equipment_current_amps
e.g. 10
Electric vehicle supply equipment current amps.
charger_charge_power_kw
e.g. 2.3
Onboard charger charge power in kw.
charger_charge_amps
e.g. 10
Onboard charger charge amps.
is_standard_onboard_charger_data_estimated
e.g. false
Is the standard onboard charger data estimated.
optional_onboard_charger_max_power_kw
e.g. 22
Optional onboard charger maximum power in kw.
optional_onboard_charger_number_phases
e.g. 3
Number of onboard charger phases
optional_onboard_charger_max_current_amps
e.g. 32
Maximum current the optional onboard charger accepts per phase to achieve max power.
optional_onboard_charger_chargetime_0to100_percent_minutes
e.g. 270
Optional onboard chargetime 0 to 100% in minutes.
optional_onboard_charge_chargespeed_mph
e.g. 33.55404426
Optional onboard charge speed miles per hour.
electric_vehicle_supply_equipment_voltage
e.g. 230
Electric vehicle supply equipment voltage.
charger_max_chargespeed_mph
e.g. 3.7282271399999996
Onboard charger maximum charge speed in mph.
electric_vehicle_supply_equipment_phase_number
e.g. 1
Electric vehicle supply equipment phase number.
charger_chargetime_0to100_mins
e.g. 2580
Onboard charger chargetime 1 to 100% in minutes.
electric_vehicle_supply_equipment_power_kw
e.g. 2.3
Rate of the power delivery in kilowatts.
charger_charge_volts
e.g. 230
Onboard charger charge volts
charger_charge_phase
e.g. 1
Number of onboard charger phases.
electric_vehicle_supply_equipment_desc
e.g. 230V10A1X
Electric vehicle supply equipment description.
electric_vehicle_supply_equipment_current_amps
e.g. 10
Electric vehicle supply equipment current amps.
charger_charge_power_kw
e.g. 2.3
Onboard charger charge power in kw.
charger_charge_amps
e.g. 10
Onboard charger charge amps.
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com