Skip to content
/
Retrieve a status log for...

Retrieve a status log for a home battery

Request

A home battery status log is uniquely identified by the combination of home battery ID and the time it was sampled at.

Security
oauth2(Required scopes: home_battery:read)
Path
home_battery_idstringrequired

The ID of the specific Home Battery.

sampled_atstring, (date-time)required

The time the log's data was recorded on the device.

Example:2024-04-17T09:39:45.984584Z
Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum:"home_battery""home_battery.model""home_battery.model.make"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/home_batteries/{home_battery_id}/status_logs/2024-04-17T09:39:45.984584Z?expand=home_battery' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Retrieve a single status log for a specific home battery.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
urlstring, (uri)
Example:"https://api.ev.energy/v2/home_batteries/hoba01J5DCXX8DMJDJYGVR1DW4J7AA/status_logs/2024-04-17T09:39:45.984584Z/"
sampled_atstring, (date-time)
home_batteryHomeBattery (object) or string
One of:

A resource that represents a single, physical home battery.

capacity_watt_hoursinteger or null

The total capacity of the battery in Wh.

Example:13500
state_of_charge_percentageinteger or null

Remaining battery charge level as a whole percentage (0-100).

Example:82
charge_rate_wattsinteger or null

Current charge rate in W. A positive value indicates charging.

Example:2200
discharge_limit_percentageinteger or null

Minimum reserve charge level as a whole percentage (0-100).

Example:20
statusstringread-only

Derived operating state of the battery.

Enum:"CHARGING""DISCHARGING""IDLE""FAULT""UNKNOWN"
Example:"CHARGING"
operation_modestringread-only

Current operation mode of the battery.

Enum:"EXPORT_FOCUS""IMPORT_FOCUS""TIME_OF_USE""SELF_RELIANCE""IDLE""UNKNOWN"
Example:"SELF_RELIANCE"
Response
{
  "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": {
    "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": { … }
  },
  "capacity_watt_hours": 13500,
  "state_of_charge_percentage": 82,
  "charge_rate_watts": 2200,
  "discharge_limit_percentage": 20,
  "status": "CHARGING",
  "operation_mode": "SELF_RELIANCE"
}