Retrieve a VPP event
curl --request GET \
--url https://energy-api.flatpeak.com/vpp-events/{vpp_event_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "vpe_7d2a4c6e9b1f3a5c8e0d2f4b",
"object": "vpp_event",
"live_mode": true,
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"start_time": "2026-08-25T18:00:00Z",
"end_time": "2026-08-25T20:00:00Z",
"intervals": [
{
"start_time": "2026-08-04T20:14:00Z",
"end_time": "2026-08-04T21:00:00Z",
"power_kw": -11,
"energy_kwh": -8.4,
"cost": {
"value": 2.15,
"confidence": 1
}
}
],
"group_id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
"status": "ALLOCATION_OPEN",
"time_allocation_locks": "2026-08-25T16:00:00Z",
"allocation": [
{
"device_id": "dev_63a6087272941ef077a8fd3e",
"program_id": "vpr_6a1f8e375db9de605baadd46",
"start_time": "2026-08-25T18:00:00Z",
"end_time": "2026-08-25T19:00:00Z",
"power_kw": -4.3,
"energy_kwh": -3.3,
"cost": {
"value": -0.94,
"confidence": 1
}
}
],
"time_created": "2026-08-25T14:00:12Z",
"account_id": "acc_661677911f2197045e6cf1b1",
"event_type": "ECONOMIC",
"device_count": 61,
"time_updated": "2026-08-25T14:00:12Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}VPP events
Retrieve a VPP event
Retrieves the event with its current status and per-device allocation.
GET
/
vpp-events
/
{vpp_event_id}
Retrieve a VPP event
curl --request GET \
--url https://energy-api.flatpeak.com/vpp-events/{vpp_event_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://energy-api.flatpeak.com/vpp-events/{vpp_event_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "vpe_7d2a4c6e9b1f3a5c8e0d2f4b",
"object": "vpp_event",
"live_mode": true,
"operator_id": "opr_6a3548352c0d07e89d47b7f1",
"start_time": "2026-08-25T18:00:00Z",
"end_time": "2026-08-25T20:00:00Z",
"intervals": [
{
"start_time": "2026-08-04T20:14:00Z",
"end_time": "2026-08-04T21:00:00Z",
"power_kw": -11,
"energy_kwh": -8.4,
"cost": {
"value": 2.15,
"confidence": 1
}
}
],
"group_id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
"status": "ALLOCATION_OPEN",
"time_allocation_locks": "2026-08-25T16:00:00Z",
"allocation": [
{
"device_id": "dev_63a6087272941ef077a8fd3e",
"program_id": "vpr_6a1f8e375db9de605baadd46",
"start_time": "2026-08-25T18:00:00Z",
"end_time": "2026-08-25T19:00:00Z",
"power_kw": -4.3,
"energy_kwh": -3.3,
"cost": {
"value": -0.94,
"confidence": 1
}
}
],
"time_created": "2026-08-25T14:00:12Z",
"account_id": "acc_661677911f2197045e6cf1b1",
"event_type": "ECONOMIC",
"device_count": 61,
"time_updated": "2026-08-25T14:00:12Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}{
"object": "error",
"type": "invalid_request",
"code": "not_found",
"message": "The requested resource could not be found.",
"context": "api.price_get",
"live_mode": true,
"time_created": "2026-01-01T00:00:00Z"
}Response
VPP event response.
A VPP event as it applies to your fleet: the VPP operator's committed power per interval and the allocation of your devices' shares. Flatpeak allocates the shares. At lock, each share becomes a commitment in the device's instructions.
Flatpeak Group ID: the VPP operator's group the event was created for. Your devices that were in the group at that moment are in the event. Read it with retrieve a group.
Example:
"grp_2f6a9c1d8e3b5a7c4d0e9f1a"
| Value | Meaning |
|---|---|
ALLOCATION_OPEN | Until time_allocation_locks. Device shares can still change |
LOCKED | Shares fixed. vpp_event.update fires once for the event; read every device's share from allocation |
ACTIVE | During the window |
COMPLETE | After the window |
CANCELED | Withdrawn by the VPP operator |
Available options:
ALLOCATION_OPEN, LOCKED, ACTIVE, COMPLETE, CANCELED Example:
"ALLOCATION_OPEN"
Was this page helpful?

