Skip to content

VehicleStatusLog

Records the state of a Vehicle at a particular point in time.

urlstring, (uri)read-only
Example:"https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H/status_logs/2024-01-01T11:11:11.1111Z/"
logged_atstring, (date-time)read-only

The date and time this status information was received and stored.

sampled_atstring, (date-time)

The date and time when this data was recorded. Likely to be earlier than logged_at, but how much earlier depends on the integration and other factors.

vehiclestring or Vehicle (object)
One of:
string (uri)
state_of_charge_percentageinteger or nullread-only

How full the vehicle's battery is, as a percentage. Will be null if we are unable to get this information from the vehicle's telematics.

Example:70
is_chargingboolean or nullread-only

Is the vehicle currently receiving charge? Will be null if we are unable to get this information from the vehicle's telematics.

Default:false
is_plugged_inboolean or nullread-only

Is the vehicle currently connected to an EVSE? Will be null if we are unable to get this information from the vehicle's telematics.

Default:false
charge_rate_wattsinteger or null

The current rate of charge being received, in watts. Will be null if we are unable to get this information from the Vehicle integration.

estimated_charge_rate_wattsinteger or nullread-only

The charge rate in watts estimated from the change in battery charge level. Useful when the Vehicle integration does not report charge_rate_watts directly. Will be null if it cannot be estimated.

charge_level_watt_hoursinteger or nullread-only

The battery charge level in watt hours. Will be null if we are unable to get this information from the Vehicle integration.

target_charge_level_percentageinteger or nullread-only

The target charge level as a percentage. Will be null if we are unable to get this information from the Vehicle integration.

target_charge_level_watt_hoursinteger or nullread-only

The target charge level in watt hours. Will be null if we are unable to get this information from the Vehicle integration.

charge_energy_added_watt_hoursinteger or nullread-only

The amount of energy added during the most recent charge, as reported by the vehicle, in watt hours. Will be null if we are unable to get this information from the Vehicle integration.

minutes_to_full_chargeinteger or nullread-only

The number of minutes the vehicle predicts until it is fully charged. Will be null if we are unable to get this information from the Vehicle integration.

current_typestring or nullread-only

The current type of the EVSE the vehicle is connected to (AC or DC). Will be null if we are unable to get this information from the Vehicle integration.

Enum:"AC - Typically home chargers""DC - Typically OTG chargers"null
is_completeboolean or nullread-only

Whether the vehicle has reached the target charge level. Will be null if we are unable to get this information from the Vehicle integration.

odometer_metersinteger or nullread-only

The vehicle's odometer reading in meters. Will be null if we are unable to get this information from the Vehicle integration.

data_sourcestring or nullread-only

The integration that originated this data.

statestring or nullread-only

The state of the vehicle. Will be null if we are unable to get this information from the Vehicle integration.

Enum:"DRIVING""RECENTLY_FINISHED_DRIVING""STATIONARY""IN_SERVICE""PLUGGED_IN_NOT_CHARGING""PLUGGED_IN_CHARGING""PLUGGED_IN_COMPLETE""PLUGGED_IN_NEAR_READY_BY_TIME""PLUGGED_IN_ALMOST_COMPLETE""UNKNOWN"
{ "url": "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H/status_logs/2024-01-01T11:11:11.1111Z/", "logged_at": "2019-08-24T14:15:22Z", "sampled_at": "2019-08-24T14:15:22Z", "vehicle": "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H", "state_of_charge_percentage": 70, "is_charging": false, "is_plugged_in": false, "charge_rate_watts": 0, "estimated_charge_rate_watts": 0, "charge_level_watt_hours": 0, "target_charge_level_percentage": 0, "target_charge_level_watt_hours": 0, "charge_energy_added_watt_hours": 0, "minutes_to_full_charge": 0, "current_type": "AC - Typically home chargers", "is_complete": true, "odometer_meters": 0, "data_source": "string", "state": "DRIVING" }