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
| Field | Type | Required | Description |
|---|---|---|---|
[].id | string (uuid) | yes | The id of the organisation. |
[].name | string | yes | The name of the organisation. |
[].time_zone | string | yes | Default time zone for the organisation's location in IANA format. |
[].location_ids | string (uuid)[] | yes | The list of locations connected to the organisation. |
[].status | string: New, Staged, Live, Retired, Unknown | yes | Status to determine whether data collection, forecasting and planning is active |
Status codes
| Status | Description |
|---|---|
200 | Ok |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organisation_id | path | string (uuid) | yes | Organisation ID |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].id | string (uuid) | yes | The id of the location. |
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].name | string | yes | The name of the location. |
[].address | string | The main address line with street name. | |
[].address_additional | string | An optional additional address line. | |
[].house_number | integer | House number of the location. | |
[].house_number_additional | string | Additions to the house number. | |
[].zip_code | string | Zip code. | |
[].city | string | Name of the city. | |
[].country_code | string | 2 letter country code in ISO 3166-1 alpha-2 format. | |
[].time_zone | string | yes | Time zone of the location in IANA format. |
[].latitude | number (float) | Latitude of the location. | |
[].longitude | number (float) | Longitude of the location. | |
[].zoom | number (float) | Zoom level for Google Maps for viewing the entire location. | |
[].asset_topology | string (uuid)[][] | yes | Edges of directed graph representing the topology of assets at the location. |
[].main_operator_id | string (uuid) | The id of the partner. | |
[].status | string: New, Staged, Live, Retired, Unknown | yes | Status to determine whether data collection, forecasting and planning is active |
Status codes
| Status | Description |
|---|---|
200 | Ok |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organisation_id | path | string (uuid) | yes | Organisation ID |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
grid_meter | object | yes | |
grid_meter.count | integer | yes | |
grid_meter.consumption_physical_limit | number (float) | Power in watts | |
grid_meter.production_physical_limit | number (float) | Power in watts | |
grid_meter.consumption_contractual_limit | number (float) | Power in watts | |
grid_meter.production_contractual_limit | number (float) | Power in watts | |
battery | object | yes | |
battery.count | integer | yes | |
battery.capacity | number (float) | Energy in watt-hours | |
battery.charge_rate | number (float) | Power in watts | |
battery.discharge_rate | number (float) | Power in watts | |
solar | object | yes | |
solar.count | integer | yes | |
solar.panel_count | integer | yes | |
solar.installed_power | number (float) | Power in watts | |
solar.max_power | number (float) | Power in watts | |
charger | object | yes | |
charger.count | integer | yes | |
charger.charge_rate | number (float) | Power in watts | |
generator | object | yes | |
generator.count | integer | yes | |
generator.max_power | number (float) | Power in watts | |
heat_pump | object | yes | |
heat_pump.count | integer | yes |
Status codes
| Status | Description |
|---|---|
200 | Ok |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].id | string (uuid) | yes | The id of the asset. |
[].organisation_id | string (uuid) | yes | The id of the organisation. |
[].location_id | string (uuid) | yes | The id of the location. |
[].name | string | yes | Human readable name of the asset |
Status codes
| Status | Description |
|---|---|
200 | Ok |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].id | string (uuid) | yes | The id of the partner. |
[].name | string | yes | The name of the partner. |
[].enable_intake | boolean | yes | Indicates whether the partner has access to the intake product |
[].enable_simulation | boolean | yes | Indicates whether the partner has access to the simulation product |
[].enable_pricing | boolean | yes | Indicates whether the partner has access to the pricing product |
Status codes
| Status | Description |
|---|---|
200 | Ok |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
grid_meter | object | yes | |
grid_meter.count | integer | yes | |
grid_meter.consumption_physical_limit | number (float) | Power in watts | |
grid_meter.production_physical_limit | number (float) | Power in watts | |
grid_meter.consumption_contractual_limit | number (float) | Power in watts | |
grid_meter.production_contractual_limit | number (float) | Power in watts | |
battery | object | yes | |
battery.count | integer | yes | |
battery.capacity | number (float) | Energy in watt-hours | |
battery.charge_rate | number (float) | Power in watts | |
battery.discharge_rate | number (float) | Power in watts | |
solar | object | yes | |
solar.count | integer | yes | |
solar.panel_count | integer | yes | |
solar.installed_power | number (float) | Power in watts | |
solar.max_power | number (float) | Power in watts | |
charger | object | yes | |
charger.count | integer | yes | |
charger.charge_rate | number (float) | Power in watts | |
generator | object | yes | |
generator.count | integer | yes | |
generator.max_power | number (float) | Power in watts | |
heat_pump | object | yes | |
heat_pump.count | integer | yes |
Status codes
| Status | Description |
|---|---|
200 | Ok |