Zympler.

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
NameInTypeRequiredDescription
organisation_idpathstring (uuid)yesOrganisation ID
startquerystring (date-time)yesThe start datetime for the selected range (in 2024-08-21T13:00:00Z format)
endquerystring (date-time)yesThe end datetime for the selected range (in 2024-08-21T13:00:00Z format)
resolutionquerystring: 1m, 15mThe resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour
include_forecastsquerybooleanWhether or not to include forecasts.
historic_view_atquerystring (date-time)Use with care. Setting this parameter will return data as it was at the given timestamp.
Responses

Fields

FieldTypeRequiredDescription
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)The id of the location.
[].asset_idstring (uuid)The id of the asset.
[].intervalobjectyes
[].interval.startstring (date-time)yesStart time of the interval (in 2024-08-21T13:00:00Z format)
[].interval.endstring (date-time)yesEnd time of the interval (in 2024-08-21T13:00:00Z format)
[].from_gridobject
[].from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid.powernumber (float)yesThe average power for the interval in watt
[].from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_gridobject
[].to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid.powernumber (float)yesThe average power for the interval in watt
[].to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].reactive_from_gridobject
[].reactive_from_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_from_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_from_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].reactive_to_gridobject
[].reactive_to_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_to_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_to_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].dso_limitsobjectLimits imposed by the DSO on the grid connection
[].dso_limits.max_active_from_gridnumber (float)Power in watts
[].dso_limits.max_active_to_gridnumber (float)Power in watts
[].dso_limits.max_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.max_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.max_active_from_grid_assetsnumber (float)Power in watts
[].dso_limits.max_active_to_grid_assetsnumber (float)Power in watts
[].dso_limits.emergency_stop_to_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.emergency_stop_from_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.reason_active_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].dso_limits.reason_reactive_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].from_batteryobject
[].from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].from_battery.powernumber (float)yesThe average power for the interval in watt
[].from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_batteryobject
[].to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].to_battery.powernumber (float)yesThe average power for the interval in watt
[].to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_chargenumber (float)Energy in watt-hours
[].battery_state_of_charge_greyobject
[].battery_state_of_charge_grey.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_grey.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_grey.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greenobject
[].battery_state_of_charge_green.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_green.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_green.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_capacityobject
[].battery_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_capacity.powernumber (float)yesThe average power for the interval in watt
[].battery_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_percentagenumber (float)
[].from_chargerobject
[].from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].from_charger.powernumber (float)yesThe average power for the interval in watt
[].from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_chargerobject
[].to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].to_charger.powernumber (float)yesThe average power for the interval in watt
[].to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_solarobject
[].from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].from_solar.powernumber (float)yesThe average power for the interval in watt
[].from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_generatorobject
[].from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].from_generator.powernumber (float)yesThe average power for the interval in watt
[].from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_consumptionobject
[].sub_meter_consumption.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_consumption.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_consumption.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_productionobject
[].sub_meter_production.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_production.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_production.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_heat_pumpobject
[].to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_heat_pump_as_heatobject
[].from_heat_pump_as_heat.energynumber (float)yesThe energy for the interval in watt-hours
[].from_heat_pump_as_heat.powernumber (float)yesThe average power for the interval in watt
[].from_heat_pump_as_heat.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_vehicleobject
[].from_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].from_vehicle.powernumber (float)yesThe average power for the interval in watt
[].from_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_vehicleobject
[].to_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].to_vehicle.powernumber (float)yesThe average power for the interval in watt
[].to_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_state_of_chargenumber (float)
[].vehicle_capacityobject
[].vehicle_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].vehicle_capacity.powernumber (float)yesThe average power for the interval in watt
[].vehicle_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_distance_drivenobject
[].vehicle_distance_driven.lengthnumber (float)yes
[].vehicle_distance_driven.velocitynumber (float)yes
[].total_usedobject
[].total_used.energynumber (float)yesThe energy for the interval in watt-hours
[].total_used.powernumber (float)yesThe average power for the interval in watt
[].total_used.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdownobjectyesBreakdown of the energy flows between different kinds of assets.
[].breakdown.used_from_gridobject
[].breakdown.used_from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_solarobject
[].breakdown.used_from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_solar.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_batteryobject
[].breakdown.used_from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_chargerobject
[].breakdown.used_from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_gridobject
[].breakdown.solar_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_gridobject
[].breakdown.battery_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_gridobject
[].breakdown.charger_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_gridobject
[].breakdown.generator_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_gridobject
[].breakdown.unknown_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_chargerobject
[].breakdown.solar_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_batteryobject
[].breakdown.solar_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_batteryobject
[].breakdown.generator_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_chargerobject
[].breakdown.generator_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_unknownobject
[].breakdown.generator_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_generatorobject
[].breakdown.used_from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_generator.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_batteryobject
[].breakdown.grid_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_batteryobject
[].breakdown.unknown_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_chargerobject
[].breakdown.battery_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_batteryobject
[].breakdown.charger_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_chargerobject
[].breakdown.grid_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_chargerobject
[].breakdown.unknown_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_unknownobject
[].breakdown.solar_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_unknownobject
[].breakdown.battery_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_unknownobject
[].breakdown.charger_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_heat_pumpobject
[].breakdown.grid_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_heat_pumpobject
[].breakdown.battery_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_heat_pumpobject
[].breakdown.solar_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_heat_pumpobject
[].breakdown.charger_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_heat_pumpobject
[].breakdown.generator_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_heat_pumpobject
[].breakdown.unknown_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_grid_limitobject
[].from_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].from_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_grid_limitobject
[].to_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].to_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].retrieved_atstring (date-time)yesMeasurement time (in 2024-08-21T13:00:00Z format)
[].data_typestring: Telemetry, Forecast, Plan, Imbalance, EProgramyesType of a measurement
[].source_typestring: Gateway, ExternalApi, GapRepair, AnomalyRepair, ForecastyesSource of a measurement
[].data_link_idstring (uuid)The id of the data link.
[].gateway_idstring (uuid)The id of the gateway.

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden

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
NameInTypeRequiredDescription
location_idpathstring (uuid)yesLocation ID
startquerystring (date-time)yesThe start datetime for the selected range (in 2024-08-21T13:00:00Z format)
endquerystring (date-time)yesThe end datetime for the selected range (in 2024-08-21T13:00:00Z format)
resolutionquerystring: 1m, 15mThe resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour
include_forecastsquerybooleanWhether or not to include forecasts.
historic_view_atquerystring (date-time)Use with care. Setting this parameter will return data as it was at the given timestamp.
Responses

Fields

FieldTypeRequiredDescription
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)The id of the location.
[].asset_idstring (uuid)The id of the asset.
[].intervalobjectyes
[].interval.startstring (date-time)yesStart time of the interval (in 2024-08-21T13:00:00Z format)
[].interval.endstring (date-time)yesEnd time of the interval (in 2024-08-21T13:00:00Z format)
[].from_gridobject
[].from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid.powernumber (float)yesThe average power for the interval in watt
[].from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_gridobject
[].to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid.powernumber (float)yesThe average power for the interval in watt
[].to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].reactive_from_gridobject
[].reactive_from_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_from_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_from_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].reactive_to_gridobject
[].reactive_to_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_to_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_to_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].dso_limitsobjectLimits imposed by the DSO on the grid connection
[].dso_limits.max_active_from_gridnumber (float)Power in watts
[].dso_limits.max_active_to_gridnumber (float)Power in watts
[].dso_limits.max_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.max_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.max_active_from_grid_assetsnumber (float)Power in watts
[].dso_limits.max_active_to_grid_assetsnumber (float)Power in watts
[].dso_limits.emergency_stop_to_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.emergency_stop_from_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.reason_active_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].dso_limits.reason_reactive_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].from_batteryobject
[].from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].from_battery.powernumber (float)yesThe average power for the interval in watt
[].from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_batteryobject
[].to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].to_battery.powernumber (float)yesThe average power for the interval in watt
[].to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_chargenumber (float)Energy in watt-hours
[].battery_state_of_charge_greyobject
[].battery_state_of_charge_grey.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_grey.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_grey.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greenobject
[].battery_state_of_charge_green.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_green.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_green.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_capacityobject
[].battery_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_capacity.powernumber (float)yesThe average power for the interval in watt
[].battery_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_percentagenumber (float)
[].from_chargerobject
[].from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].from_charger.powernumber (float)yesThe average power for the interval in watt
[].from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_chargerobject
[].to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].to_charger.powernumber (float)yesThe average power for the interval in watt
[].to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_solarobject
[].from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].from_solar.powernumber (float)yesThe average power for the interval in watt
[].from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_generatorobject
[].from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].from_generator.powernumber (float)yesThe average power for the interval in watt
[].from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_consumptionobject
[].sub_meter_consumption.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_consumption.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_consumption.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_productionobject
[].sub_meter_production.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_production.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_production.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_heat_pumpobject
[].to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_heat_pump_as_heatobject
[].from_heat_pump_as_heat.energynumber (float)yesThe energy for the interval in watt-hours
[].from_heat_pump_as_heat.powernumber (float)yesThe average power for the interval in watt
[].from_heat_pump_as_heat.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_vehicleobject
[].from_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].from_vehicle.powernumber (float)yesThe average power for the interval in watt
[].from_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_vehicleobject
[].to_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].to_vehicle.powernumber (float)yesThe average power for the interval in watt
[].to_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_state_of_chargenumber (float)
[].vehicle_capacityobject
[].vehicle_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].vehicle_capacity.powernumber (float)yesThe average power for the interval in watt
[].vehicle_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_distance_drivenobject
[].vehicle_distance_driven.lengthnumber (float)yes
[].vehicle_distance_driven.velocitynumber (float)yes
[].total_usedobject
[].total_used.energynumber (float)yesThe energy for the interval in watt-hours
[].total_used.powernumber (float)yesThe average power for the interval in watt
[].total_used.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdownobjectyesBreakdown of the energy flows between different kinds of assets.
[].breakdown.used_from_gridobject
[].breakdown.used_from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_solarobject
[].breakdown.used_from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_solar.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_batteryobject
[].breakdown.used_from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_chargerobject
[].breakdown.used_from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_gridobject
[].breakdown.solar_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_gridobject
[].breakdown.battery_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_gridobject
[].breakdown.charger_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_gridobject
[].breakdown.generator_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_gridobject
[].breakdown.unknown_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_chargerobject
[].breakdown.solar_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_batteryobject
[].breakdown.solar_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_batteryobject
[].breakdown.generator_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_chargerobject
[].breakdown.generator_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_unknownobject
[].breakdown.generator_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_generatorobject
[].breakdown.used_from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_generator.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_batteryobject
[].breakdown.grid_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_batteryobject
[].breakdown.unknown_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_chargerobject
[].breakdown.battery_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_batteryobject
[].breakdown.charger_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_chargerobject
[].breakdown.grid_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_chargerobject
[].breakdown.unknown_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_unknownobject
[].breakdown.solar_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_unknownobject
[].breakdown.battery_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_unknownobject
[].breakdown.charger_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_heat_pumpobject
[].breakdown.grid_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_heat_pumpobject
[].breakdown.battery_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_heat_pumpobject
[].breakdown.solar_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_heat_pumpobject
[].breakdown.charger_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_heat_pumpobject
[].breakdown.generator_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_heat_pumpobject
[].breakdown.unknown_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_grid_limitobject
[].from_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].from_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_grid_limitobject
[].to_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].to_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].retrieved_atstring (date-time)yesMeasurement time (in 2024-08-21T13:00:00Z format)
[].data_typestring: Telemetry, Forecast, Plan, Imbalance, EProgramyesType of a measurement
[].source_typestring: Gateway, ExternalApi, GapRepair, AnomalyRepair, ForecastyesSource of a measurement
[].data_link_idstring (uuid)The id of the data link.
[].gateway_idstring (uuid)The id of the gateway.

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden

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
NameInTypeRequiredDescription
asset_idpathstring (uuid)yesAsset ID
startquerystring (date-time)yesThe start datetime for the selected range (in 2024-08-21T13:00:00Z format)
endquerystring (date-time)yesThe end datetime for the selected range (in 2024-08-21T13:00:00Z format)
resolutionquerystring: 1m, 15mThe resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour
include_descendantsquerybooleanWhether or not to include descendant assets.
include_forecastsquerybooleanWhether or not to include forecasts.
historic_view_atquerystring (date-time)Use with care. Setting this parameter will return data as it was at the given timestamp.
Responses

Fields

FieldTypeRequiredDescription
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)The id of the location.
[].asset_idstring (uuid)The id of the asset.
[].intervalobjectyes
[].interval.startstring (date-time)yesStart time of the interval (in 2024-08-21T13:00:00Z format)
[].interval.endstring (date-time)yesEnd time of the interval (in 2024-08-21T13:00:00Z format)
[].from_gridobject
[].from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid.powernumber (float)yesThe average power for the interval in watt
[].from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_gridobject
[].to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid.powernumber (float)yesThe average power for the interval in watt
[].to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].reactive_from_gridobject
[].reactive_from_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_from_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_from_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].reactive_to_gridobject
[].reactive_to_grid.energynumber (float)yesThe reactive energy for the interval in var-hours
[].reactive_to_grid.powernumber (float)yesThe average reactive power for the interval in var
[].reactive_to_grid.power_maxnumber (float)yesThe maximum reactive power for the interval in var
[].dso_limitsobjectLimits imposed by the DSO on the grid connection
[].dso_limits.max_active_from_gridnumber (float)Power in watts
[].dso_limits.max_active_to_gridnumber (float)Power in watts
[].dso_limits.max_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.max_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_from_gridnumber (float)Reactive power in var
[].dso_limits.min_reactive_to_gridnumber (float)Reactive power in var
[].dso_limits.max_active_from_grid_assetsnumber (float)Power in watts
[].dso_limits.max_active_to_grid_assetsnumber (float)Power in watts
[].dso_limits.emergency_stop_to_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.emergency_stop_from_gridstring: NormalOperation, DisconnectEmergency stop state requested by the DSO
[].dso_limits.reason_active_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].dso_limits.reason_reactive_power_limitstring: Normal, GridCongestion, Maintenance, VoltageControl, Test, OtherReason given by the DSO for a power limit
[].from_batteryobject
[].from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].from_battery.powernumber (float)yesThe average power for the interval in watt
[].from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_batteryobject
[].to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].to_battery.powernumber (float)yesThe average power for the interval in watt
[].to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_chargenumber (float)Energy in watt-hours
[].battery_state_of_charge_greyobject
[].battery_state_of_charge_grey.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_grey.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_grey.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greenobject
[].battery_state_of_charge_green.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_green.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_green.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_capacityobject
[].battery_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_capacity.powernumber (float)yesThe average power for the interval in watt
[].battery_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_percentagenumber (float)
[].from_chargerobject
[].from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].from_charger.powernumber (float)yesThe average power for the interval in watt
[].from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_chargerobject
[].to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].to_charger.powernumber (float)yesThe average power for the interval in watt
[].to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_solarobject
[].from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].from_solar.powernumber (float)yesThe average power for the interval in watt
[].from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_generatorobject
[].from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].from_generator.powernumber (float)yesThe average power for the interval in watt
[].from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_consumptionobject
[].sub_meter_consumption.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_consumption.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_consumption.power_maxnumber (float)yesThe maximum power for the interval in watt
[].sub_meter_productionobject
[].sub_meter_production.energynumber (float)yesThe energy for the interval in watt-hours
[].sub_meter_production.powernumber (float)yesThe average power for the interval in watt
[].sub_meter_production.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_heat_pumpobject
[].to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_heat_pump_as_heatobject
[].from_heat_pump_as_heat.energynumber (float)yesThe energy for the interval in watt-hours
[].from_heat_pump_as_heat.powernumber (float)yesThe average power for the interval in watt
[].from_heat_pump_as_heat.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_vehicleobject
[].from_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].from_vehicle.powernumber (float)yesThe average power for the interval in watt
[].from_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_vehicleobject
[].to_vehicle.energynumber (float)yesThe energy for the interval in watt-hours
[].to_vehicle.powernumber (float)yesThe average power for the interval in watt
[].to_vehicle.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_state_of_chargenumber (float)
[].vehicle_capacityobject
[].vehicle_capacity.energynumber (float)yesThe energy for the interval in watt-hours
[].vehicle_capacity.powernumber (float)yesThe average power for the interval in watt
[].vehicle_capacity.power_maxnumber (float)yesThe maximum power for the interval in watt
[].vehicle_distance_drivenobject
[].vehicle_distance_driven.lengthnumber (float)yes
[].vehicle_distance_driven.velocitynumber (float)yes
[].total_usedobject
[].total_used.energynumber (float)yesThe energy for the interval in watt-hours
[].total_used.powernumber (float)yesThe average power for the interval in watt
[].total_used.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdownobjectyesBreakdown of the energy flows between different kinds of assets.
[].breakdown.used_from_gridobject
[].breakdown.used_from_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_solarobject
[].breakdown.used_from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_solar.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_batteryobject
[].breakdown.used_from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_chargerobject
[].breakdown.used_from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_gridobject
[].breakdown.solar_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_gridobject
[].breakdown.battery_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_gridobject
[].breakdown.charger_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_gridobject
[].breakdown.generator_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_gridobject
[].breakdown.unknown_to_grid.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_grid.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_grid.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_chargerobject
[].breakdown.solar_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_batteryobject
[].breakdown.solar_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_batteryobject
[].breakdown.generator_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_chargerobject
[].breakdown.generator_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_unknownobject
[].breakdown.generator_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.used_from_generatorobject
[].breakdown.used_from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.used_from_generator.powernumber (float)yesThe average power for the interval in watt
[].breakdown.used_from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_batteryobject
[].breakdown.grid_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_batteryobject
[].breakdown.unknown_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_chargerobject
[].breakdown.battery_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_batteryobject
[].breakdown.charger_to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_battery.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_chargerobject
[].breakdown.grid_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_chargerobject
[].breakdown.unknown_to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_charger.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_unknownobject
[].breakdown.solar_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_unknownobject
[].breakdown.battery_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_unknownobject
[].breakdown.charger_to_unknown.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_unknown.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_unknown.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.grid_to_heat_pumpobject
[].breakdown.grid_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.grid_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.grid_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.battery_to_heat_pumpobject
[].breakdown.battery_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.battery_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.battery_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.solar_to_heat_pumpobject
[].breakdown.solar_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.solar_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.solar_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.charger_to_heat_pumpobject
[].breakdown.charger_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.charger_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.charger_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.generator_to_heat_pumpobject
[].breakdown.generator_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.generator_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.generator_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].breakdown.unknown_to_heat_pumpobject
[].breakdown.unknown_to_heat_pump.energynumber (float)yesThe energy for the interval in watt-hours
[].breakdown.unknown_to_heat_pump.powernumber (float)yesThe average power for the interval in watt
[].breakdown.unknown_to_heat_pump.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_grid_limitobject
[].from_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].from_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].from_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_grid_limitobject
[].to_grid_limit.energynumber (float)yesThe energy for the interval in watt-hours
[].to_grid_limit.powernumber (float)yesThe average power for the interval in watt
[].to_grid_limit.power_maxnumber (float)yesThe maximum power for the interval in watt
[].retrieved_atstring (date-time)yesMeasurement time (in 2024-08-21T13:00:00Z format)
[].data_typestring: Telemetry, Forecast, Plan, Imbalance, EProgramyesType of a measurement
[].source_typestring: Gateway, ExternalApi, GapRepair, AnomalyRepair, ForecastyesSource of a measurement
[].data_link_idstring (uuid)The id of the data link.
[].gateway_idstring (uuid)The id of the gateway.

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden

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
NameInTypeRequiredDescription
location_idpathstring (uuid)yesLocation ID
startquerystring (date-time)yesThe start datetime for the selected range (in 2024-08-21T13:00:00Z format)
endquerystring (date-time)yesThe end datetime for the selected range (in 2024-08-21T13:00:00Z format)
resolutionquerystring: 1m, 15mThe resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour
historic_view_atquerystring (date-time)Use with care. Setting this parameter will return data as it was at the given timestamp.
Responses

Fields

FieldTypeRequiredDescription
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)yesThe id of the location.
[].asset_idstring (uuid)yesThe id of the asset.
[].intervalobjectyes
[].interval.startstring (date-time)yesStart time of the interval (in 2024-08-21T13:00:00Z format)
[].interval.endstring (date-time)yesEnd time of the interval (in 2024-08-21T13:00:00Z format)
[].from_batteryobject
[].from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].from_battery.powernumber (float)yesThe average power for the interval in watt
[].from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_batteryobject
[].to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].to_battery.powernumber (float)yesThe average power for the interval in watt
[].to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_chargeobject
[].battery_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greyobject
[].battery_state_of_charge_grey.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_grey.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_grey.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greenobject
[].battery_state_of_charge_green.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_green.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_green.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_minimum_state_of_chargeobject
[].battery_minimum_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_minimum_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_minimum_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_maximum_state_of_chargeobject
[].battery_maximum_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_maximum_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_maximum_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_chargerobject
[].from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].from_charger.powernumber (float)yesThe average power for the interval in watt
[].from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_chargerobject
[].to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].to_charger.powernumber (float)yesThe average power for the interval in watt
[].to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_solarobject
[].from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].from_solar.powernumber (float)yesThe average power for the interval in watt
[].from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].curtailed_solarobject
[].curtailed_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].curtailed_solar.powernumber (float)yesThe average power for the interval in watt
[].curtailed_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_generatorobject
[].from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].from_generator.powernumber (float)yesThe average power for the interval in watt
[].from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].planned_atstring (date-time)yesPlanning time (in 2024-08-21T13:00:00Z format)

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden

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
NameInTypeRequiredDescription
asset_idpathstring (uuid)yesAsset ID
startquerystring (date-time)yesThe start datetime for the selected range (in 2024-08-21T13:00:00Z format)
endquerystring (date-time)yesThe end datetime for the selected range (in 2024-08-21T13:00:00Z format)
resolutionquerystring: 1m, 15mThe resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour
historic_view_atquerystring (date-time)Use with care. Setting this parameter will return data as it was at the given timestamp.
Responses

Fields

FieldTypeRequiredDescription
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)yesThe id of the location.
[].asset_idstring (uuid)yesThe id of the asset.
[].intervalobjectyes
[].interval.startstring (date-time)yesStart time of the interval (in 2024-08-21T13:00:00Z format)
[].interval.endstring (date-time)yesEnd time of the interval (in 2024-08-21T13:00:00Z format)
[].from_batteryobject
[].from_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].from_battery.powernumber (float)yesThe average power for the interval in watt
[].from_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_batteryobject
[].to_battery.energynumber (float)yesThe energy for the interval in watt-hours
[].to_battery.powernumber (float)yesThe average power for the interval in watt
[].to_battery.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_chargeobject
[].battery_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greyobject
[].battery_state_of_charge_grey.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_grey.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_grey.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_state_of_charge_greenobject
[].battery_state_of_charge_green.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_state_of_charge_green.powernumber (float)yesThe average power for the interval in watt
[].battery_state_of_charge_green.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_minimum_state_of_chargeobject
[].battery_minimum_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_minimum_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_minimum_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].battery_maximum_state_of_chargeobject
[].battery_maximum_state_of_charge.energynumber (float)yesThe energy for the interval in watt-hours
[].battery_maximum_state_of_charge.powernumber (float)yesThe average power for the interval in watt
[].battery_maximum_state_of_charge.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_chargerobject
[].from_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].from_charger.powernumber (float)yesThe average power for the interval in watt
[].from_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].to_chargerobject
[].to_charger.energynumber (float)yesThe energy for the interval in watt-hours
[].to_charger.powernumber (float)yesThe average power for the interval in watt
[].to_charger.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_solarobject
[].from_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].from_solar.powernumber (float)yesThe average power for the interval in watt
[].from_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].curtailed_solarobject
[].curtailed_solar.energynumber (float)yesThe energy for the interval in watt-hours
[].curtailed_solar.powernumber (float)yesThe average power for the interval in watt
[].curtailed_solar.power_maxnumber (float)yesThe maximum power for the interval in watt
[].from_generatorobject
[].from_generator.energynumber (float)yesThe energy for the interval in watt-hours
[].from_generator.powernumber (float)yesThe average power for the interval in watt
[].from_generator.power_maxnumber (float)yesThe maximum power for the interval in watt
[].planned_atstring (date-time)yesPlanning time (in 2024-08-21T13:00:00Z format)

Status codes

StatusDescription
200Ok
400Bad Request
401Unauthorized
403Forbidden
Search