Zympler.

Resources

The organisations, locations and assets your service account has access to.

The structure: organisations, their locations (sites), and the assets at each location, such as grid meters, batteries, solar inverters, EV chargers, generators and heat pumps. The asset summaries give totals per asset type, like installed battery capacity or the number of chargers.

The platform hosts many customers, but these endpoints only ever return what your service account is allowed to see. Most integrations start here, to find the IDs the other sections take as parameters.

List organisations

GET /organisations

curl

curl -X GET "https://api.zympler.com/v1beta/organisations" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let response = reqwest::Client::new()
    .get("https://api.zympler.com/v1beta/organisations")
    .bearer_auth(&token)
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;

Python

response = requests.get(
    "https://api.zympler.com/v1beta/organisations",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Responses

Fields

FieldTypeRequiredDescription
[].idstring (uuid)yesThe id of the organisation.
[].namestringyesThe name of the organisation.
[].time_zonestringyesDefault time zone for the organisation's location in IANA format.
[].location_idsstring (uuid)[]yesThe list of locations connected to the organisation.
[].statusstring: New, Staged, Live, Retired, UnknownyesStatus to determine whether data collection, forecasting and planning is active

Status codes

StatusDescription
200Ok

List locations for an organisation

GET /organisations/{organisation_id}/locations

curl

ORGANISATION_ID="<organisation_id>"

curl -X GET "https://api.zympler.com/v1beta/organisations/$ORGANISATION_ID/locations" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let organisation_id = "<organisation_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/organisations/{organisation_id}/locations"))
    .bearer_auth(&token)
    .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/organisations/{organisation_id}/locations",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
organisation_idpathstring (uuid)yesOrganisation ID
Responses

Fields

FieldTypeRequiredDescription
[].idstring (uuid)yesThe id of the location.
[].organisation_idstring (uuid)yesThe id of the organisation.
[].namestringyesThe name of the location.
[].addressstringThe main address line with street name.
[].address_additionalstringAn optional additional address line.
[].house_numberintegerHouse number of the location.
[].house_number_additionalstringAdditions to the house number.
[].zip_codestringZip code.
[].citystringName of the city.
[].country_codestring2 letter country code in ISO 3166-1 alpha-2 format.
[].time_zonestringyesTime zone of the location in IANA format.
[].latitudenumber (float)Latitude of the location.
[].longitudenumber (float)Longitude of the location.
[].zoomnumber (float)Zoom level for Google Maps for viewing the entire location.
[].asset_topologystring (uuid)[][]yesEdges of directed graph representing the topology of assets at the location.
[].main_operator_idstring (uuid)The id of the partner.
[].statusstring: New, Staged, Live, Retired, UnknownyesStatus to determine whether data collection, forecasting and planning is active

Status codes

StatusDescription
200Ok

Get asset summary for an organisation

GET /organisations/{organisation_id}/asset-summary

curl

ORGANISATION_ID="<organisation_id>"

curl -X GET "https://api.zympler.com/v1beta/organisations/$ORGANISATION_ID/asset-summary" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let organisation_id = "<organisation_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/organisations/{organisation_id}/asset-summary"))
    .bearer_auth(&token)
    .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/organisations/{organisation_id}/asset-summary",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
organisation_idpathstring (uuid)yesOrganisation ID
Responses

Fields

FieldTypeRequiredDescription
grid_meterobjectyes
grid_meter.countintegeryes
grid_meter.consumption_physical_limitnumber (float)Power in watts
grid_meter.production_physical_limitnumber (float)Power in watts
grid_meter.consumption_contractual_limitnumber (float)Power in watts
grid_meter.production_contractual_limitnumber (float)Power in watts
batteryobjectyes
battery.countintegeryes
battery.capacitynumber (float)Energy in watt-hours
battery.charge_ratenumber (float)Power in watts
battery.discharge_ratenumber (float)Power in watts
solarobjectyes
solar.countintegeryes
solar.panel_countintegeryes
solar.installed_powernumber (float)Power in watts
solar.max_powernumber (float)Power in watts
chargerobjectyes
charger.countintegeryes
charger.charge_ratenumber (float)Power in watts
generatorobjectyes
generator.countintegeryes
generator.max_powernumber (float)Power in watts
heat_pumpobjectyes
heat_pump.countintegeryes

Status codes

StatusDescription
200Ok

List assets for a location

GET /locations/{location_id}/assets

curl

LOCATION_ID="<location_id>"

curl -X GET "https://api.zympler.com/v1beta/locations/$LOCATION_ID/assets" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let location_id = "<location_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/locations/{location_id}/assets"))
    .bearer_auth(&token)
    .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/locations/{location_id}/assets",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
location_idpathstring (uuid)yesLocation ID
Responses

Fields

FieldTypeRequiredDescription
[].idstring (uuid)yesThe id of the asset.
[].organisation_idstring (uuid)yesThe id of the organisation.
[].location_idstring (uuid)yesThe id of the location.
[].namestringyesHuman readable name of the asset

Status codes

StatusDescription
200Ok

List accessible partners linked to a location

GET /locations/{location_id}/partners

Lists the partners linked to the location that the user has access to. Users with a global role get all linked partners, users with partner roles only the linked partners they have a role for.

curl

LOCATION_ID="<location_id>"

curl -X GET "https://api.zympler.com/v1beta/locations/$LOCATION_ID/partners" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let location_id = "<location_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/locations/{location_id}/partners"))
    .bearer_auth(&token)
    .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/locations/{location_id}/partners",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
location_idpathstring (uuid)yesLocation ID
Responses

Fields

FieldTypeRequiredDescription
[].idstring (uuid)yesThe id of the partner.
[].namestringyesThe name of the partner.
[].enable_intakebooleanyesIndicates whether the partner has access to the intake product
[].enable_simulationbooleanyesIndicates whether the partner has access to the simulation product
[].enable_pricingbooleanyesIndicates whether the partner has access to the pricing product

Status codes

StatusDescription
200Ok

Get asset summary for a location

GET /locations/{location_id}/asset-summary

curl

LOCATION_ID="<location_id>"

curl -X GET "https://api.zympler.com/v1beta/locations/$LOCATION_ID/asset-summary" \
  -H "Authorization: Bearer $ZYMPLER_TOKEN"

Rust

let location_id = "<location_id>";
let response = reqwest::Client::new()
    .get(format!("https://api.zympler.com/v1beta/locations/{location_id}/asset-summary"))
    .bearer_auth(&token)
    .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/locations/{location_id}/asset-summary",
    headers={"Authorization": f"Bearer {token}"},
    timeout=30,
)
response.raise_for_status()
data = response.json()
Parameters
NameInTypeRequiredDescription
location_idpathstring (uuid)yesLocation ID
Responses

Fields

FieldTypeRequiredDescription
grid_meterobjectyes
grid_meter.countintegeryes
grid_meter.consumption_physical_limitnumber (float)Power in watts
grid_meter.production_physical_limitnumber (float)Power in watts
grid_meter.consumption_contractual_limitnumber (float)Power in watts
grid_meter.production_contractual_limitnumber (float)Power in watts
batteryobjectyes
battery.countintegeryes
battery.capacitynumber (float)Energy in watt-hours
battery.charge_ratenumber (float)Power in watts
battery.discharge_ratenumber (float)Power in watts
solarobjectyes
solar.countintegeryes
solar.panel_countintegeryes
solar.installed_powernumber (float)Power in watts
solar.max_powernumber (float)Power in watts
chargerobjectyes
charger.countintegeryes
charger.charge_ratenumber (float)Power in watts
generatorobjectyes
generator.countintegeryes
generator.max_powernumber (float)Power in watts
heat_pumpobjectyes
heat_pump.countintegeryes

Status codes

StatusDescription
200Ok
Search