Skip to content
/
Get live power data for a...

Get live power data for a HEM system

Request

Returns live power data for the HEM system. Power values (in watts) are derived from the most recent energy statistics, including raw measurements and calculated power flows between sources (solar, battery, grid) and destinations (home, battery, grid).

Security
oauth2(Required scopes: home_energy:read)
Path
hem_system_idstringrequired

The ID of the specific HEM system.

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/hem_systems/{hem_system_id}/live_power' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns live power data for the HEM system.

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
sampled_atstring, (date-time)read-onlyrequired

The timestamp of the energy statistics period.

Example:"2024-06-15T12:00:00Z"
generation_wattsinteger or nullread-onlyrequired

Solar generation power in watts. Null if inverter stats unavailable.

Example:3000
consumption_wattsinteger or nullread-onlyrequired

Household consumption power in watts. Null if any required stats unavailable.

Example:2400
import_wattsinteger or nullread-onlyrequired

Power imported from the grid in watts. Null if any required stats unavailable.

Example:1200
export_wattsinteger or nullread-onlyrequired

Power exported to the grid in watts. Null if any required stats unavailable.

Example:600
charge_wattsinteger or nullread-onlyrequired

Battery charging power in watts. Null if any required stats unavailable.

Example:1800
discharge_wattsinteger or nullread-onlyrequired

Battery discharging power in watts. Null if any required stats unavailable.

Example:900
solar_to_home_wattsinteger or nullread-onlyrequired

Derived power flow from solar to home in watts. Null if any required stats unavailable.

Example:1500
solar_to_battery_wattsinteger or nullread-onlyrequired

Derived power flow from solar to battery in watts. Null if any required stats unavailable.

Example:1000
solar_to_grid_wattsinteger or nullread-onlyrequired

Derived power flow from solar to grid in watts. Null if any required stats unavailable.

Example:500
battery_to_home_wattsinteger or nullread-onlyrequired

Derived power flow from battery to home in watts. Null if any required stats unavailable.

Example:700
battery_to_grid_wattsinteger or nullread-onlyrequired

Derived power flow from battery to grid in watts. Null if any required stats unavailable.

Example:200
grid_to_home_wattsinteger or nullread-onlyrequired

Derived power flow from grid to home in watts. Null if any required stats unavailable.

Example:200
grid_to_battery_wattsinteger or nullread-onlyrequired

Derived power flow from grid to battery in watts. Null if any required stats unavailable.

Example:100
battery_state_of_charge_percentageinteger or nullread-onlyrequired

Battery state of charge as a percentage (0-100). Null if unavailable.

Example:82
Response
{
  "sampled_at": "2024-06-15T12:00:00Z",
  "generation_watts": 3000,
  "consumption_watts": 2400,
  "import_watts": 1200,
  "export_watts": 600,
  "charge_watts": 1800,
  "discharge_watts": 900,
  "solar_to_home_watts": 1500,
  "solar_to_battery_watts": 1000,
  "solar_to_grid_watts": 500,
  "battery_to_home_watts": 700,
  "battery_to_grid_watts": 200,
  "grid_to_home_watts": 200,
  "grid_to_battery_watts": 100,
  "battery_state_of_charge_percentage": 82
}