External control
For balance responsible parties (BRPs) that steer assets themselves.
With external control, the BRP decides what an asset does: it sends battery setpoints or solar curtailment through these endpoints, in 1- or 15-minute intervals up to 7 days ahead, and reads the available flexibility to know what's possible. Zympler only steps in when following a setpoint would exceed the limits of the grid connection.
External control only works for assets that Zympler has switched from internal control (
InternalControl: Zympler plans and steers) to external control (ExternalControl). Contact support@zympler.com to arrange this. Send setpoints per asset; the location-level control endpoints are not recommended and not documented here.
We're working on a hybrid mode, in which Zympler plans the site and submits a nomination to the BRP a day ahead, and the BRP can still override individual assets. See the roadmap.
Get available flexibility at location for next 24 hours in 15 minute intervals
GET /locations/{location_id}/available-flexibility
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/locations/$LOCATION_ID/available-flexibility" \
-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}/available-flexibility"))
.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}/available-flexibility",
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 |
start | query | string (date-time) | The start datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour | |
end | query | string (date-time) | The end datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
organisation_id | string (uuid) | yes | The id of the organisation. |
location_id | string (uuid) | yes | The id of the location. |
flexibility | object | yes | |
flexibility.current | object | yes | |
flexibility.current.solar_power | number (float) | yes | Current amount of solar power in watts |
flexibility.intervals | object[] | yes | The amount of flexibility for each 15 minute interval in the next 24 hours |
flexibility.intervals[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
flexibility.intervals[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
flexibility.intervals[].solar_power | number (float) | yes | Expected amount of solar power in watts |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get curtailed solar yield at location in selected range
GET /locations/{location_id}/curtailed-solar
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/locations/$LOCATION_ID/curtailed-solar?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/locations/{location_id}/curtailed-solar"))
.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/locations/{location_id}/curtailed-solar",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
location_id | path | string (uuid) | yes | Location ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
organisation_id | string (uuid) | yes | The id of the organisation. |
location_id | string (uuid) | yes | The id of the location. |
curtailment | object[] | yes | The amount of curtailment for each interval in the selected range |
curtailment[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
curtailment[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
curtailment[].solar_energy | number (float) | yes | Amount of solar yield in watts-hours |
curtailment[].curtailed_energy | number (float) | yes | Amount of curtailed solar yield in watt-hours |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get solar control curtailment actions
GET /assets/{asset_id}/control-solar
curl
ASSET_ID="<asset_id>"
curl -X GET "https://api.zympler.com/v1beta/assets/$ASSET_ID/control-solar?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/assets/{asset_id}/control-solar"))
.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/assets/{asset_id}/control-solar",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].action | object | yes |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Set solar control curtailment actions in either 15m or 1m intervals, less than 7 days ahead
POST /assets/{asset_id}/control-solar
curl
ASSET_ID="<asset_id>"
curl -X POST "https://api.zympler.com/v1beta/assets/$ASSET_ID/control-solar" \
-H "Authorization: Bearer $ZYMPLER_TOKEN" \
-H "Content-Type: application/json" \
-d '[
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"curtail_solar": true
}
}
]'Rust
let asset_id = "<asset_id>";
let response = reqwest::Client::new()
.post(format!("https://api.zympler.com/v1beta/assets/{asset_id}/control-solar"))
.bearer_auth(&token)
.json(&serde_json::json!([
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"curtail_solar": true
}
}
]))
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
asset_id = "<asset_id>"
response = requests.post(
f"https://api.zympler.com/v1beta/assets/{asset_id}/control-solar",
headers={"Authorization": f"Bearer {token}"},
json=[
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"curtail_solar": True,
},
},
],
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].action | object | yes |
Responses
Status codes
| Status | Description |
|---|---|
200 | Successfully planned solar control |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get curtailed solar yield for an asset in selected range
GET /assets/{asset_id}/curtailed-solar
curl
ASSET_ID="<asset_id>"
curl -X GET "https://api.zympler.com/v1beta/assets/$ASSET_ID/curtailed-solar?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/assets/{asset_id}/curtailed-solar"))
.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/assets/{asset_id}/curtailed-solar",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
asset_id | string (uuid) | yes | The id of the asset. |
curtailment | object[] | yes | The amount of curtailment for each interval in the selected range |
curtailment[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
curtailment[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
curtailment[].solar_energy | number (float) | yes | Amount of solar yield in watts-hours |
curtailment[].curtailed_energy | number (float) | yes | Amount of curtailed solar yield in watt-hours |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get available battery flexibility at location in 15 minute intervals
GET /location/{location_id}/flexibility-battery
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/location/$LOCATION_ID/flexibility-battery" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let location_id = "<location_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/location/{location_id}/flexibility-battery"))
.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/location/{location_id}/flexibility-battery",
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 |
start | query | string (date-time) | The start datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour | |
end | query | string (date-time) | The end datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:15:00Z format) |
[].to_battery | number (float) | yes | Power in watts |
[].from_battery | number (float) | yes | Power in watts |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get available solar flexibility at location in 15 minute intervals
GET /location/{location_id}/flexibility-solar
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/location/$LOCATION_ID/flexibility-solar" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let location_id = "<location_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/location/{location_id}/flexibility-solar"))
.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/location/{location_id}/flexibility-solar",
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 |
start | query | string (date-time) | The start datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour | |
end | query | string (date-time) | The end datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:15:00Z format) |
[].solar | number (float) | Power in watts |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get available grid flexibility (W) at location in 15 minute, 1 hour or 2 hour intervals
GET /location/{location_id}/flexibility-grid
For resolutions longer than 15 minutes, grid_take is the smallest available grid take of
the 15-minute intervals within each interval, so it can be taken for the whole interval
without exceeding the grid limit. start is rounded down and end is rounded up to
the resolution in the location's time zone.
curl
LOCATION_ID="<location_id>"
curl -X GET "https://api.zympler.com/v1beta/location/$LOCATION_ID/flexibility-grid" \
-H "Authorization: Bearer $ZYMPLER_TOKEN"Rust
let location_id = "<location_id>";
let response = reqwest::Client::new()
.get(format!("https://api.zympler.com/v1beta/location/{location_id}/flexibility-grid"))
.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/location/{location_id}/flexibility-grid",
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 |
start | query | string (date-time) | The start datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour | |
end | query | string (date-time) | The end datetime for the selected range (in 2024-08-21T13:00:00Z format), aligned to a quarter of an hour | |
resolution | query | string: 15m, 1h, 2h | The resolution of the interval (quarter of an hour, hour or two hours), defaults to quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:15:00Z format) |
[].grid_take | number (float) | Power in watts |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Get battery control setpoints
GET /assets/{asset_id}/control-battery
curl
ASSET_ID="<asset_id>"
curl -X GET "https://api.zympler.com/v1beta/assets/$ASSET_ID/control-battery?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/assets/{asset_id}/control-battery"))
.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/assets/{asset_id}/control-battery",
headers={"Authorization": f"Bearer {token}"},
params={
"start": "2026-01-01T00:00:00Z",
"end": "2026-01-01T00:00:00Z",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
start | query | string (date-time) | yes | The start datetime for the selected range (in 2024-08-21T13:00:00Z format) |
end | query | string (date-time) | yes | The end datetime for the selected range (in 2024-08-21T13:00:00Z format) |
resolution | query | string: 1m, 15m | The resolution of the interval (minute or quarter of an hour), defaults to quarter of an hour |
Responses
Fields
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].action | object | object | yes |
Status codes
| Status | Description |
|---|---|
200 | Ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
Set battery control setpoint(s) in either 15m or 1m intervals, less than 7 days ahead
POST /assets/{asset_id}/control-battery
curl
ASSET_ID="<asset_id>"
curl -X POST "https://api.zympler.com/v1beta/assets/$ASSET_ID/control-battery" \
-H "Authorization: Bearer $ZYMPLER_TOKEN" \
-H "Content-Type: application/json" \
-d '[
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"to_battery": 0.0
}
}
]'Rust
let asset_id = "<asset_id>";
let response = reqwest::Client::new()
.post(format!("https://api.zympler.com/v1beta/assets/{asset_id}/control-battery"))
.bearer_auth(&token)
.json(&serde_json::json!([
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"to_battery": 0.0
}
}
]))
.send()
.await?
.error_for_status()?;
let body: serde_json::Value = response.json().await?;Python
asset_id = "<asset_id>"
response = requests.post(
f"https://api.zympler.com/v1beta/assets/{asset_id}/control-battery",
headers={"Authorization": f"Bearer {token}"},
json=[
{
"start": "2024-08-21T13:00:00Z",
"end": "2024-08-21T13:15:00Z",
"action": {
"to_battery": 0.0,
},
},
],
timeout=30,
)
response.raise_for_status()
data = response.json()Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
asset_id | path | string (uuid) | yes | Asset ID |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
[].start | string (date-time) | yes | Start time of the interval (in 2024-08-21T13:00:00Z format) |
[].end | string (date-time) | yes | End time of the interval (in 2024-08-21T13:00:00Z format) |
[].action | object | object | yes |
Responses
Status codes
| Status | Description |
|---|---|
200 | Successfully planned battery control |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |