API Reference
Get Flow Type Summary
Get flow type summary (per bidding zone border, bucketed by resolution).
Datetime params accept ISO 8601 or relative shorthand (now, now-30d, now-1H, etc.). All datetimes resolve to UTC. Response meta includes resolved_datetime_from/to. Default range: now-30d to now. Returns envelope with data array.
resolution: 1H, 1D, 1W, native, or auto. Default: auto (server picks based on range width; native forces raw data regardless of range).
GET
/
api
/
v1
/
flow-type-summary
Get Flow Type Summary
curl --request GET \
--url https://api.example.com/api/v1/flow-type-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/v1/flow-type-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/v1/flow-type-summary', 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://api.example.com/api/v1/flow-type-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.example.com/api/v1/flow-type-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/flow-type-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/flow-type-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"provenance": "measured",
"upstream_sources": [
"<string>"
],
"resolved_datetime_from": "2023-11-07T05:31:56Z",
"resolved_datetime_to": "2023-11-07T05:31:56Z",
"resolution": "<string>"
},
"data": [
{
"day": "2023-11-07T05:31:56Z",
"bidding_zone_from": "<string>",
"bidding_zone_to": "<string>",
"convergence": 123,
"congestion": 123,
"counter_intuitive": 123,
"outage": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Query Parameters
Border pairs as 'ZONE_FROM->ZONE_TO', e.g. 'DE->FR'
Available options:
auto, native, 1H, 1D, 1W ⌘I
Get Flow Type Summary
curl --request GET \
--url https://api.example.com/api/v1/flow-type-summary \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/v1/flow-type-summary"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/v1/flow-type-summary', 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://api.example.com/api/v1/flow-type-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.example.com/api/v1/flow-type-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/flow-type-summary")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/flow-type-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"meta": {
"provenance": "measured",
"upstream_sources": [
"<string>"
],
"resolved_datetime_from": "2023-11-07T05:31:56Z",
"resolved_datetime_to": "2023-11-07T05:31:56Z",
"resolution": "<string>"
},
"data": [
{
"day": "2023-11-07T05:31:56Z",
"bidding_zone_from": "<string>",
"bidding_zone_to": "<string>",
"convergence": 123,
"congestion": 123,
"counter_intuitive": 123,
"outage": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}