GuidesAPI ReferenceChangelogDiscussions
Log In
Guides

Vehicles

Vehicle endpoints expose electric vehicles linked to an address, including identity, location, odometer, and charge state.

Base path: /api/v2/addresses/:address_uuid/vehicles
Permission: READ_VEHICLE_DATA

What we provide

MethodPathPurpose
GET/List vehicles for the address

Payload

Typical vehicle object includes:

  • Identity (identifier)
  • VIN
  • Info metadata
  • lastLocation
  • lastOdometer
  • lastChargeState, including fields such as:
    • isPluggedIn
    • isCharging
    • isFullyCharged
    • batteryLevel (%)
    • range (km)
    • batteryCapacity (kWh)
    • chargeLimit (%)
    • maxCurrent (A)
    • powerDeliveryState
    • time
  • Created / updated / deleted timestamps

Current surface boundary

This domain is currently read-oriented. You can inventory vehicles and inspect latest known charge/location/odometer state. Direct vehicle control is not part of the documented vehicle surface in this version.

Guidance

  • Expect intermittent sparsity: vehicle telemetry often depends on vendor polling cadence and connectivity.
  • Always surface “last updated” (time) in operator UIs.
  • Correlate vehicle charge state with charger data when both exist at the same address.
  • Use deleted timestamps to distinguish active inventory from historical records.

Did this page help you?