v1

latestOpenAPI 3.0.0Apache 2.02026-07-26916119.7 KB
Vehicle Data

Get Historical States

Returns historical states for a vehicle during a timeframe.

If no interval is specified, a sensible interval based on the timeframe is used.

get/{vin}/states

Path parameters

vinstring required

The associated VIN.

Query parameters

fromnumber

The start of the timeframe. Unix timestamp in seconds.

tonumber

The end of the timeframe. Unix timestamp in seconds.

intervalnumber
Example:1

The desired number of seconds between data points. Set to 1 to return all data points.

condenseboolean

Whether to condense data output.

timezonestring

The IANA timezone name.

distance_format'mi' | 'km'

Whether to return data in miles or kilometers.

temperature_format'c' | 'f'

Whether to return data in Fahrenheit or Celsius.

format'json' | 'csv'

Whether to output the results in JSON or CSV.

Response

Success

OR

Example response

{
  "results": [
    {
      "id": 1644010170,
      "timestamp": 1644010170,
      "state": "online",
      "charging_state": "Charging",
      "shift_state": "P",
      "battery_level": 88,
      "usable_battery_level": 88,
      "battery_range": 266.69,
      "ideal_battery_range": 999,
      "latitude": 40.7128,
      "longitude": 74.006,
      "odometer": 14096.5,
      "charge_rate": 1,
      "charger_actual_current": 12,
      "charger_power": 1,
      "charger_phases": 1,
      "charger_voltage": 118,
      "charge_energy_added": 4.64,
      "charge_miles_added_rated": 1.5,
      "charge_miles_added_ideal": 422,
      "inside_temp": 37.7,
      "outside_temp": 20.5,
      "locked": 1,
      "lifetime_energy_used": 5224.71,
      "energy_remaining": 51.26,
      "pack_current": -0.7,
      "pack_voltage": 419.79,
      "module_temp_min": 25.5,
      "module_temp_max": 26
    }
  ]
}