Bi-directional charging provides the opportunity for an EV owner to derive additional benefits from their car by using it to store electricity during times of low demand (and cost) before using it to power their home appliances or sell power back to the grid at times of peak demand.
In the used electric vehicle market a car with these capabilities has the potential to command a higher price if the benefits are properly communicated to the buyer, providing an additional profit opportunity for sellers.
Key Features
Vehicle to Home
Identifies whether the vehicle can be used as a household power source
Vehicle to Grid
Identifies whether a vehicle is capable of sending energy back to the grid
Vehicle to Load
Identifies whether the vehicle is capable of powering other devices
Bi-Directional Charge Port Details
Interior and exterior charge port details for bi-directional charging
AC/DC Output Capability
Identifies whether AC and/or DC output is available for each type of bi-directional charging
Maximum Power Output
Identifies the maximum power output in each bi-directional charging scenario
Sample Response
V1
Documentation
Introduction
This endpoint provides the bi-directional charging capabilities of an electric car.
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/bidirectionalcharging/?evdb_vehicle_id=1234
Example Sandbox Request
https://sandbox.oneautoapi.com/evdatabase/uk/car/bidirectionalcharging/?evdb_vehicle_id=1234
Request Parameters
evdb_vehicle_id
mandatory, string, e.g. 1234
EV Database Vehicle ID
Sample Response
{
"success": true,
"result": {
"vehicle_to_load_support_status": "Announced",
"vehicle_to_load_power_output_kw": 11,
"vehicle_to_load_exterior_port_details": "1 x Type 2 (Adapter)",
"vehicle_to_load_interior_port_details": "1 x UK Socket (BS1363)",
"vehicle_to_home_ac_support_status": "Not Available",
"vehicle_to_home_ac_power_output_kw": 11,
"vehicle_to_home_dc_support_status": "Announced",
"vehicle_to_home_dc_power_output_kw": 10,
"vehicle_to_grid_ac_support_status": "Announced",
"vehicle_to_grid_ac_power_output_kw": 11,
"vehicle_to_grid_dc_support_status": "Announced",
"vehicle_to_grid_dc_power_output_kw": 11
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
vehicle_to_load_support_status
e.g. Announced
Indicates whether the vehicle battery can be used to power an electrical appliance
vehicle_to_load_power_output_kw
e.g. 11
The maximum power output when powering an electrical appliance.
vehicle_to_load_exterior_port_details
e.g. 1 x Type 2 (Adapter)
Details of the exterior Vehicle to Load ports.
vehicle_to_load_interior_port_details
e.g. 1 x UK Socket (BS1363)
Details of the interior Vehicle to Load ports
vehicle_to_home_ac_support_status
e.g. Not Available
Indicates whether the vehicle battery can be used to provide AC power to a home
vehicle_to_home_ac_power_output_kw
e.g. 11
The maximum AC power output when powering a home
vehicle_to_home_dc_support_status
e.g. Announced
Indicates whether the vehicle battery can be used to provide DC power to a home
vehicle_to_home_dc_power_output_kw
e.g. 10
The maximum DC power output when powering a home
vehicle_to_grid_ac_support_status
e.g. Announced
Indicates whether the vehicle battery can be used to provide AC power to the grid
vehicle_to_grid_ac_power_output_kw
e.g. 11
The maximum AC power output to the grid
vehicle_to_grid_dc_support_status
e.g. Announced
Indicates whether the vehicle battery can be used to provide DC power to the grid
vehicle_to_grid_dc_power_output_kw
e.g. 11
The maximum DC power output to the grid
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