HomeBattery

A resource that represents a single, physical home battery.

idstringhoba[A-Z\d]{26}read-onlyrequired

Unique identifier for the given Home Battery.

Example:"hoba01J5DCXX8DMJDJYGVR1DW4J7AA"

urlstring, (uri)read-onlyrequired

Example:"https://api.ev.energy/v2/home_batteries/hoba01J5DCXX8DMJDJYGVR1DW4J7AA"

modelstring or HomeBatteryModel (object)

One of:

string (uri)

user(string or null) or User (object)read-only

Example:"https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"

One of:

The owner of this home battery. Defaults to a url, but can be expanded to the full User resource via the expand query parameter.

string or null (uri)read-only

created_atstring or null, (date-time)read-only

When this home battery was connected to the platform.

Example:"2024-03-15T14:22:33.123456Z"

latest_status_logHomeBatteryStatusLog (object) or (string or null)

One of:

Records the state of a home battery at a particular point in time.

{
  "id": "hoba01J5DCXX8DMJDJYGVR1DW4J7AA",
  "url": "https://api.ev.energy/v2/home_batteries/hoba01J5DCXX8DMJDJYGVR1DW4J7AA",
  "model": "https://api.ev.energy/v2/home_battery_models/bmod7XL7Q5294J6TUZARBQT2D1EOHY",
  "user": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "created_at": "2024-03-15T14:22:33.123456Z",
  "latest_status_log": {
    "url": "https://api.ev.energy/v2/home_batteries/hoba01J5DCXX8DMJDJYGVR1DW4J7AA/status_logs/2024-04-17T09:39:45.984584Z/",
    "sampled_at": "2019-08-24T14:15:22Z",
    "home_battery": { … },
    "capacity_watt_hours": 13500,
    "state_of_charge_percentage": 82,
    "charge_rate_watts": 2200,
    "discharge_limit_percentage": 20,
    "status": "CHARGING",
    "operation_mode": "SELF_RELIANCE"
  }
}