Skip to content
/
Retrieve a home battery

Retrieve a home battery

Request

Retrieve a single, specific home battery's details.

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

The ID of the specific Home Battery to retrieve.

Query
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum:"model""model.make""user""latest_status_log"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/home_batteries/{home_battery_id}?expand=model' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a single 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
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.

Response
{
  "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"
  }
}