Plan
What Zympler intends to do at a site.
The plan per organisation, location or asset, with planned battery (dis)charging, charging and solar production per interval, optionally together with the forecasts it is based on. The long term plan is the underlying plan before short-term adjustments.
You can also request the plan as it was at an earlier moment, to compare it with what happened.
Get merged asset plan for organisation
GET /plan/organisations/{organisation_id}
curl
ORGANISATION_ID="<organisation_id>"
curl -X GET "https://api.zympler.com/v1beta/plan/organisations/$ORGANISATION_ID?start=2026-01-01T00:00:00Z&end=2026-01-01T00:00:00Z" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let organisation_id = "<organisation_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/plan/organisations/{organisation_id}"))
.bearer_auth(&token)
.query(&[("start", "2026-01-01T00:00:00Z"), ("end", "2026-01-01T00:00:00Z")])
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
organisation_id = "<organisation_id>"
response = requests.get(
f"https://api.zympler.com/v1beta/plan/organisations/{organisation_id}",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organisation_id | path | string (uuid) | yes | Organisation ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour | |
include_forecasts | query | boolean | Whether or not to include forecasts. | |
historic_view_at | query | string (date-time) | Use with care. Setting this parameter will return data as it was at the given timestamp. |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | The id of the location. | |
[].asset_id | string (uuid) | The id of the asset. | |
[].interval | object | yes | |
[].interval.start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].interval.end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].from_grid | object | ||
[].from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid.power | number (float) | yes | The average power for the interval in watt |
[].from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid | object | ||
[].to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid.power | number (float) | yes | The average power for the interval in watt |
[].to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].reactive_from_grid | object | ||
[].reactive_from_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_from_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_from_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].reactive_to_grid | object | ||
[].reactive_to_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_to_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_to_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].dso_limits | object | Limits imposed by the DSO on the grid connection | |
[].dso_limits.max_active_from_grid | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid | number (float) | Power in watts | |
[].dso_limits.max_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.max_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.max_active_from_grid_assets | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid_assets | number (float) | Power in watts | |
[].dso_limits.emergency_stop_to_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.emergency_stop_from_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.reason_active_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].dso_limits.reason_reactive_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].from_battery | object | ||
[].from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_battery.power | number (float) | yes | The average power for the interval in watt |
[].from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_battery | object | ||
[].to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_battery.power | number (float) | yes | The average power for the interval in watt |
[].to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge | number (float) | Energy in watt-hours | |
[].battery_state_of_charge_grey | object | ||
[].battery_state_of_charge_grey.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_grey.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_grey.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_green | object | ||
[].battery_state_of_charge_green.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_green.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_green.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_capacity | object | ||
[].battery_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_capacity.power | number (float) | yes | The average power for the interval in watt |
[].battery_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_percentage | number (float) | ||
[].from_charger | object | ||
[].from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_charger.power | number (float) | yes | The average power for the interval in watt |
[].from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_charger | object | ||
[].to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_charger.power | number (float) | yes | The average power for the interval in watt |
[].to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_solar | object | ||
[].from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_solar.power | number (float) | yes | The average power for the interval in watt |
[].from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_generator | object | ||
[].from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_generator.power | number (float) | yes | The average power for the interval in watt |
[].from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_consumption | object | ||
[].sub_meter_consumption.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_consumption.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_consumption.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_production | object | ||
[].sub_meter_production.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_production.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_production.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_heat_pump | object | ||
[].to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_heat_pump_as_heat | object | ||
[].from_heat_pump_as_heat.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_heat_pump_as_heat.power | number (float) | yes | The average power for the interval in watt |
[].from_heat_pump_as_heat.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_vehicle | object | ||
[].from_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].from_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_vehicle | object | ||
[].to_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].to_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_state_of_charge | number (float) | ||
[].vehicle_capacity | object | ||
[].vehicle_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].vehicle_capacity.power | number (float) | yes | The average power for the interval in watt |
[].vehicle_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_distance_driven | object | ||
[].vehicle_distance_driven.length | number (float) | yes | |
[].vehicle_distance_driven.velocity | number (float) | yes | |
[].total_used | object | ||
[].total_used.energy | number (float) | yes | The energy for the interval in watt-hours |
[].total_used.power | number (float) | yes | The average power for the interval in watt |
[].total_used.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown | object | yes | Breakdown of the energy flows between different kinds of assets. |
[].breakdown.used_from_grid | object | ||
[].breakdown.used_from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_solar | object | ||
[].breakdown.used_from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_solar.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_battery | object | ||
[].breakdown.used_from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_charger | object | ||
[].breakdown.used_from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_grid | object | ||
[].breakdown.solar_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_grid | object | ||
[].breakdown.battery_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_grid | object | ||
[].breakdown.charger_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_grid | object | ||
[].breakdown.generator_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_grid | object | ||
[].breakdown.unknown_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_charger | object | ||
[].breakdown.solar_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_battery | object | ||
[].breakdown.solar_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_battery | object | ||
[].breakdown.generator_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_charger | object | ||
[].breakdown.generator_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_unknown | object | ||
[].breakdown.generator_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_generator | object | ||
[].breakdown.used_from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_generator.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_battery | object | ||
[].breakdown.grid_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_battery | object | ||
[].breakdown.unknown_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_charger | object | ||
[].breakdown.battery_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_battery | object | ||
[].breakdown.charger_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_charger | object | ||
[].breakdown.grid_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_charger | object | ||
[].breakdown.unknown_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_unknown | object | ||
[].breakdown.solar_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_unknown | object | ||
[].breakdown.battery_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_unknown | object | ||
[].breakdown.charger_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_heat_pump | object | ||
[].breakdown.grid_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_heat_pump | object | ||
[].breakdown.battery_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_heat_pump | object | ||
[].breakdown.solar_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_heat_pump | object | ||
[].breakdown.charger_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_heat_pump | object | ||
[].breakdown.generator_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_heat_pump | object | ||
[].breakdown.unknown_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_grid_limit | object | ||
[].from_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].from_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid_limit | object | ||
[].to_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].to_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].retrieved_at | string (date-time) | yes | Measurement time (in 2024-08-21T13:00:00Z format) |
[].data_type | string: Telemetry, Forecast, Plan, Imbalance, EProgram | yes | Type of a measurement |
[].source_type | string: Gateway, ExternalApi, GapRepair, AnomalyRepair, Forecast | yes | Source of a measurement |
[].data_link_id | string (uuid) | The id of the data link. | |
[].gateway_id | string (uuid) | The id of the gateway. |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get merged asset plan for location
GET /plan/locations/{location_id}
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/plan/locations/$LOCATION_ID?start=2026-01-01T00:00:00Z&end=2026-01-01T00:00:00Z" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let location_id = "<location_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/plan/locations/{location_id}"))
.bearer_auth(&token)
.query(&[("start", "2026-01-01T00:00:00Z"), ("end", "2026-01-01T00:00:00Z")])
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
location_id = "<location_id>"
response = requests.get(
f"https://api.zympler.com/v1beta/plan/locations/{location_id}",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour | |
include_forecasts | query | boolean | Whether or not to include forecasts. | |
historic_view_at | query | string (date-time) | Use with care. Setting this parameter will return data as it was at the given timestamp. |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | The id of the location. | |
[].asset_id | string (uuid) | The id of the asset. | |
[].interval | object | yes | |
[].interval.start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].interval.end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].from_grid | object | ||
[].from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid.power | number (float) | yes | The average power for the interval in watt |
[].from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid | object | ||
[].to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid.power | number (float) | yes | The average power for the interval in watt |
[].to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].reactive_from_grid | object | ||
[].reactive_from_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_from_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_from_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].reactive_to_grid | object | ||
[].reactive_to_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_to_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_to_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].dso_limits | object | Limits imposed by the DSO on the grid connection | |
[].dso_limits.max_active_from_grid | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid | number (float) | Power in watts | |
[].dso_limits.max_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.max_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.max_active_from_grid_assets | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid_assets | number (float) | Power in watts | |
[].dso_limits.emergency_stop_to_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.emergency_stop_from_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.reason_active_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].dso_limits.reason_reactive_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].from_battery | object | ||
[].from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_battery.power | number (float) | yes | The average power for the interval in watt |
[].from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_battery | object | ||
[].to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_battery.power | number (float) | yes | The average power for the interval in watt |
[].to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge | number (float) | Energy in watt-hours | |
[].battery_state_of_charge_grey | object | ||
[].battery_state_of_charge_grey.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_grey.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_grey.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_green | object | ||
[].battery_state_of_charge_green.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_green.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_green.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_capacity | object | ||
[].battery_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_capacity.power | number (float) | yes | The average power for the interval in watt |
[].battery_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_percentage | number (float) | ||
[].from_charger | object | ||
[].from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_charger.power | number (float) | yes | The average power for the interval in watt |
[].from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_charger | object | ||
[].to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_charger.power | number (float) | yes | The average power for the interval in watt |
[].to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_solar | object | ||
[].from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_solar.power | number (float) | yes | The average power for the interval in watt |
[].from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_generator | object | ||
[].from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_generator.power | number (float) | yes | The average power for the interval in watt |
[].from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_consumption | object | ||
[].sub_meter_consumption.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_consumption.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_consumption.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_production | object | ||
[].sub_meter_production.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_production.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_production.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_heat_pump | object | ||
[].to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_heat_pump_as_heat | object | ||
[].from_heat_pump_as_heat.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_heat_pump_as_heat.power | number (float) | yes | The average power for the interval in watt |
[].from_heat_pump_as_heat.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_vehicle | object | ||
[].from_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].from_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_vehicle | object | ||
[].to_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].to_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_state_of_charge | number (float) | ||
[].vehicle_capacity | object | ||
[].vehicle_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].vehicle_capacity.power | number (float) | yes | The average power for the interval in watt |
[].vehicle_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_distance_driven | object | ||
[].vehicle_distance_driven.length | number (float) | yes | |
[].vehicle_distance_driven.velocity | number (float) | yes | |
[].total_used | object | ||
[].total_used.energy | number (float) | yes | The energy for the interval in watt-hours |
[].total_used.power | number (float) | yes | The average power for the interval in watt |
[].total_used.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown | object | yes | Breakdown of the energy flows between different kinds of assets. |
[].breakdown.used_from_grid | object | ||
[].breakdown.used_from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_solar | object | ||
[].breakdown.used_from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_solar.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_battery | object | ||
[].breakdown.used_from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_charger | object | ||
[].breakdown.used_from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_grid | object | ||
[].breakdown.solar_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_grid | object | ||
[].breakdown.battery_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_grid | object | ||
[].breakdown.charger_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_grid | object | ||
[].breakdown.generator_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_grid | object | ||
[].breakdown.unknown_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_charger | object | ||
[].breakdown.solar_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_battery | object | ||
[].breakdown.solar_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_battery | object | ||
[].breakdown.generator_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_charger | object | ||
[].breakdown.generator_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_unknown | object | ||
[].breakdown.generator_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_generator | object | ||
[].breakdown.used_from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_generator.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_battery | object | ||
[].breakdown.grid_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_battery | object | ||
[].breakdown.unknown_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_charger | object | ||
[].breakdown.battery_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_battery | object | ||
[].breakdown.charger_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_charger | object | ||
[].breakdown.grid_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_charger | object | ||
[].breakdown.unknown_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_unknown | object | ||
[].breakdown.solar_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_unknown | object | ||
[].breakdown.battery_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_unknown | object | ||
[].breakdown.charger_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_heat_pump | object | ||
[].breakdown.grid_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_heat_pump | object | ||
[].breakdown.battery_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_heat_pump | object | ||
[].breakdown.solar_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_heat_pump | object | ||
[].breakdown.charger_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_heat_pump | object | ||
[].breakdown.generator_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_heat_pump | object | ||
[].breakdown.unknown_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_grid_limit | object | ||
[].from_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].from_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid_limit | object | ||
[].to_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].to_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].retrieved_at | string (date-time) | yes | Measurement time (in 2024-08-21T13:00:00Z format) |
[].data_type | string: Telemetry, Forecast, Plan, Imbalance, EProgram | yes | Type of a measurement |
[].source_type | string: Gateway, ExternalApi, GapRepair, AnomalyRepair, Forecast | yes | Source of a measurement |
[].data_link_id | string (uuid) | The id of the data link. | |
[].gateway_id | string (uuid) | The id of the gateway. |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get merged asset plan for asset
GET /plan/assets/{asset_id}
curl
ASSET_ID="<asset_id>"
curl -X GET "https://api.zympler.com/v1beta/plan/assets/$ASSET_ID?start=2026-01-01T00:00:00Z&end=2026-01-01T00:00:00Z" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let asset_id = "<asset_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/plan/assets/{asset_id}"))
.bearer_auth(&token)
.query(&[("start", "2026-01-01T00:00:00Z"), ("end", "2026-01-01T00:00:00Z")])
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
asset_id = "<asset_id>"
response = requests.get(
f"https://api.zympler.com/v1beta/plan/assets/{asset_id}",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour | |
include_descendants | query | boolean | Whether or not to include descendant assets. | |
include_forecasts | query | boolean | Whether or not to include forecasts. | |
historic_view_at | query | string (date-time) | Use with care. Setting this parameter will return data as it was at the given timestamp. |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | The id of the location. | |
[].asset_id | string (uuid) | The id of the asset. | |
[].interval | object | yes | |
[].interval.start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].interval.end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].from_grid | object | ||
[].from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid.power | number (float) | yes | The average power for the interval in watt |
[].from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid | object | ||
[].to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid.power | number (float) | yes | The average power for the interval in watt |
[].to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].reactive_from_grid | object | ||
[].reactive_from_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_from_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_from_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].reactive_to_grid | object | ||
[].reactive_to_grid.energy | number (float) | yes | The reactive energy for the interval in var-hours |
[].reactive_to_grid.power | number (float) | yes | The average reactive power for the interval in var |
[].reactive_to_grid.power_max | number (float) | yes | The maximum reactive power for the interval in var |
[].dso_limits | object | Limits imposed by the DSO on the grid connection | |
[].dso_limits.max_active_from_grid | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid | number (float) | Power in watts | |
[].dso_limits.max_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.max_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_from_grid | number (float) | Reactive power in var | |
[].dso_limits.min_reactive_to_grid | number (float) | Reactive power in var | |
[].dso_limits.max_active_from_grid_assets | number (float) | Power in watts | |
[].dso_limits.max_active_to_grid_assets | number (float) | Power in watts | |
[].dso_limits.emergency_stop_to_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.emergency_stop_from_grid | string: NormalOperation, Disconnect | Emergency stop state requested by the DSO | |
[].dso_limits.reason_active_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].dso_limits.reason_reactive_power_limit | string: Normal, GridCongestion, Maintenance, VoltageControl, Test, Other | Reason given by the DSO for a power limit | |
[].from_battery | object | ||
[].from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_battery.power | number (float) | yes | The average power for the interval in watt |
[].from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_battery | object | ||
[].to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_battery.power | number (float) | yes | The average power for the interval in watt |
[].to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge | number (float) | Energy in watt-hours | |
[].battery_state_of_charge_grey | object | ||
[].battery_state_of_charge_grey.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_grey.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_grey.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_green | object | ||
[].battery_state_of_charge_green.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_green.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_green.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_capacity | object | ||
[].battery_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_capacity.power | number (float) | yes | The average power for the interval in watt |
[].battery_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_percentage | number (float) | ||
[].from_charger | object | ||
[].from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_charger.power | number (float) | yes | The average power for the interval in watt |
[].from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_charger | object | ||
[].to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_charger.power | number (float) | yes | The average power for the interval in watt |
[].to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_solar | object | ||
[].from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_solar.power | number (float) | yes | The average power for the interval in watt |
[].from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_generator | object | ||
[].from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_generator.power | number (float) | yes | The average power for the interval in watt |
[].from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_consumption | object | ||
[].sub_meter_consumption.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_consumption.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_consumption.power_max | number (float) | yes | The maximum power for the interval in watt |
[].sub_meter_production | object | ||
[].sub_meter_production.energy | number (float) | yes | The energy for the interval in watt-hours |
[].sub_meter_production.power | number (float) | yes | The average power for the interval in watt |
[].sub_meter_production.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_heat_pump | object | ||
[].to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_heat_pump_as_heat | object | ||
[].from_heat_pump_as_heat.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_heat_pump_as_heat.power | number (float) | yes | The average power for the interval in watt |
[].from_heat_pump_as_heat.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_vehicle | object | ||
[].from_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].from_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_vehicle | object | ||
[].to_vehicle.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_vehicle.power | number (float) | yes | The average power for the interval in watt |
[].to_vehicle.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_state_of_charge | number (float) | ||
[].vehicle_capacity | object | ||
[].vehicle_capacity.energy | number (float) | yes | The energy for the interval in watt-hours |
[].vehicle_capacity.power | number (float) | yes | The average power for the interval in watt |
[].vehicle_capacity.power_max | number (float) | yes | The maximum power for the interval in watt |
[].vehicle_distance_driven | object | ||
[].vehicle_distance_driven.length | number (float) | yes | |
[].vehicle_distance_driven.velocity | number (float) | yes | |
[].total_used | object | ||
[].total_used.energy | number (float) | yes | The energy for the interval in watt-hours |
[].total_used.power | number (float) | yes | The average power for the interval in watt |
[].total_used.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown | object | yes | Breakdown of the energy flows between different kinds of assets. |
[].breakdown.used_from_grid | object | ||
[].breakdown.used_from_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_solar | object | ||
[].breakdown.used_from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_solar.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_battery | object | ||
[].breakdown.used_from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_charger | object | ||
[].breakdown.used_from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_grid | object | ||
[].breakdown.solar_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_grid | object | ||
[].breakdown.battery_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_grid | object | ||
[].breakdown.charger_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_grid | object | ||
[].breakdown.generator_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_grid | object | ||
[].breakdown.unknown_to_grid.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_grid.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_grid.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_charger | object | ||
[].breakdown.solar_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_battery | object | ||
[].breakdown.solar_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_battery | object | ||
[].breakdown.generator_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_charger | object | ||
[].breakdown.generator_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_unknown | object | ||
[].breakdown.generator_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.used_from_generator | object | ||
[].breakdown.used_from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.used_from_generator.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.used_from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_battery | object | ||
[].breakdown.grid_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_battery | object | ||
[].breakdown.unknown_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_charger | object | ||
[].breakdown.battery_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_battery | object | ||
[].breakdown.charger_to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_battery.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_charger | object | ||
[].breakdown.grid_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_charger | object | ||
[].breakdown.unknown_to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_charger.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_unknown | object | ||
[].breakdown.solar_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_unknown | object | ||
[].breakdown.battery_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_unknown | object | ||
[].breakdown.charger_to_unknown.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_unknown.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_unknown.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.grid_to_heat_pump | object | ||
[].breakdown.grid_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.grid_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.grid_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.battery_to_heat_pump | object | ||
[].breakdown.battery_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.battery_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.battery_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.solar_to_heat_pump | object | ||
[].breakdown.solar_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.solar_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.solar_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.charger_to_heat_pump | object | ||
[].breakdown.charger_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.charger_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.charger_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.generator_to_heat_pump | object | ||
[].breakdown.generator_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.generator_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.generator_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].breakdown.unknown_to_heat_pump | object | ||
[].breakdown.unknown_to_heat_pump.energy | number (float) | yes | The energy for the interval in watt-hours |
[].breakdown.unknown_to_heat_pump.power | number (float) | yes | The average power for the interval in watt |
[].breakdown.unknown_to_heat_pump.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_grid_limit | object | ||
[].from_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].from_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_grid_limit | object | ||
[].to_grid_limit.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_grid_limit.power | number (float) | yes | The average power for the interval in watt |
[].to_grid_limit.power_max | number (float) | yes | The maximum power for the interval in watt |
[].retrieved_at | string (date-time) | yes | Measurement time (in 2024-08-21T13:00:00Z format) |
[].data_type | string: Telemetry, Forecast, Plan, Imbalance, EProgram | yes | Type of a measurement |
[].source_type | string: Gateway, ExternalApi, GapRepair, AnomalyRepair, Forecast | yes | Source of a measurement |
[].data_link_id | string (uuid) | The id of the data link. | |
[].gateway_id | string (uuid) | The id of the gateway. |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get underlying long term plan for location
GET /long-term-plan/locations/{location_id}
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/long-term-plan/locations/$LOCATION_ID?start=2026-01-01T00:00:00Z&end=2026-01-01T00:00:00Z" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let location_id = "<location_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/long-term-plan/locations/{location_id}"))
.bearer_auth(&token)
.query(&[("start", "2026-01-01T00:00:00Z"), ("end", "2026-01-01T00:00:00Z")])
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
location_id = "<location_id>"
response = requests.get(
f"https://api.zympler.com/v1beta/long-term-plan/locations/{location_id}",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour | |
historic_view_at | query | string (date-time) | Use with care. Setting this parameter will return data as it was at the given timestamp. |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | yes | The id of the location. |
[].asset_id | string (uuid) | yes | The id of the asset. |
[].interval | object | yes | |
[].interval.start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].interval.end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].from_battery | object | ||
[].from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_battery.power | number (float) | yes | The average power for the interval in watt |
[].from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_battery | object | ||
[].to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_battery.power | number (float) | yes | The average power for the interval in watt |
[].to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge | object | ||
[].battery_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_grey | object | ||
[].battery_state_of_charge_grey.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_grey.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_grey.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_green | object | ||
[].battery_state_of_charge_green.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_green.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_green.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_minimum_state_of_charge | object | ||
[].battery_minimum_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_minimum_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_minimum_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_maximum_state_of_charge | object | ||
[].battery_maximum_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_maximum_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_maximum_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_charger | object | ||
[].from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_charger.power | number (float) | yes | The average power for the interval in watt |
[].from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_charger | object | ||
[].to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_charger.power | number (float) | yes | The average power for the interval in watt |
[].to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_solar | object | ||
[].from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_solar.power | number (float) | yes | The average power for the interval in watt |
[].from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].curtailed_solar | object | ||
[].curtailed_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].curtailed_solar.power | number (float) | yes | The average power for the interval in watt |
[].curtailed_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_generator | object | ||
[].from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_generator.power | number (float) | yes | The average power for the interval in watt |
[].from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].planned_at | string (date-time) | yes | Planning time (in 2024-08-21T13:00:00Z format) |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get underlying long term plan for asset
GET /long-term-plan/assets/{asset_id}
curl
ASSET_ID="<asset_id>"
curl -X GET "https://api.zympler.com/v1beta/long-term-plan/assets/$ASSET_ID?start=2026-01-01T00:00:00Z&end=2026-01-01T00:00:00Z" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let asset_id = "<asset_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/long-term-plan/assets/{asset_id}"))
.bearer_auth(&token)
.query(&[("start", "2026-01-01T00:00:00Z"), ("end", "2026-01-01T00:00:00Z")])
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
asset_id = "<asset_id>"
response = requests.get(
f"https://api.zympler.com/v1beta/long-term-plan/assets/{asset_id}",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour | |
historic_view_at | query | string (date-time) | Use with care. Setting this parameter will return data as it was at the given timestamp. |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | yes | The id of the location. |
[].asset_id | string (uuid) | yes | The id of the asset. |
[].interval | object | yes | |
[].interval.start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].interval.end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].from_battery | object | ||
[].from_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_battery.power | number (float) | yes | The average power for the interval in watt |
[].from_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_battery | object | ||
[].to_battery.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_battery.power | number (float) | yes | The average power for the interval in watt |
[].to_battery.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge | object | ||
[].battery_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_grey | object | ||
[].battery_state_of_charge_grey.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_grey.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_grey.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_state_of_charge_green | object | ||
[].battery_state_of_charge_green.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_state_of_charge_green.power | number (float) | yes | The average power for the interval in watt |
[].battery_state_of_charge_green.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_minimum_state_of_charge | object | ||
[].battery_minimum_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_minimum_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_minimum_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].battery_maximum_state_of_charge | object | ||
[].battery_maximum_state_of_charge.energy | number (float) | yes | The energy for the interval in watt-hours |
[].battery_maximum_state_of_charge.power | number (float) | yes | The average power for the interval in watt |
[].battery_maximum_state_of_charge.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_charger | object | ||
[].from_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_charger.power | number (float) | yes | The average power for the interval in watt |
[].from_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].to_charger | object | ||
[].to_charger.energy | number (float) | yes | The energy for the interval in watt-hours |
[].to_charger.power | number (float) | yes | The average power for the interval in watt |
[].to_charger.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_solar | object | ||
[].from_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_solar.power | number (float) | yes | The average power for the interval in watt |
[].from_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].curtailed_solar | object | ||
[].curtailed_solar.energy | number (float) | yes | The energy for the interval in watt-hours |
[].curtailed_solar.power | number (float) | yes | The average power for the interval in watt |
[].curtailed_solar.power_max | number (float) | yes | The maximum power for the interval in watt |
[].from_generator | object | ||
[].from_generator.energy | number (float) | yes | The energy for the interval in watt-hours |
[].from_generator.power | number (float) | yes | The average power for the interval in watt |
[].from_generator.power_max | number (float) | yes | The maximum power for the interval in watt |
[].planned_at | string (date-time) | yes | Planning time (in 2024-08-21T13:00:00Z format) |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |