Skip to main content
GET
/
schedule-management
/
v1
/
mabis
/
clearing-periods
/
{uid}
Get Clearing Period
curl --request GET \
  --url https://api.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}', 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.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}",
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: <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.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<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.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.engrate.io/schedule-management/v1/mabis/clearing-periods/{uid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "clearing_period": {
    "bilanzierungsmonat": "<string>",
    "bilanzkreis_eic": "<string>",
    "created_ts": "<string>",
    "last_modified_ts": "<string>",
    "org_uid": "<string>",
    "status": "<string>",
    "uid": "<string>",
    "final_deadline": "2026-03-31T23:59:59+02:00",
    "objection_deadline": "2026-03-13T23:59:59+01:00",
    "preliminary_deadline": "2026-02-25T23:59:59+01:00",
    "total_imbalance_cost_eur": 1875,
    "total_imbalance_mwh": 12.5
  },
  "message_count": 123,
  "objection_count": 123,
  "settlement_count": 123,
  "deadline_type": "preliminary",
  "total_imbalance_cost_eur": 123,
  "total_imbalance_mwh": 123,
  "upcoming_deadline": "2026-02-25T23:59:59+01:00"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}

Authorizations

Authorization
string
header
required

Path Parameters

uid
string<uuid>
required

Clearing period unique identifier.

Response

Successful Response

Summary view for a clearing period including counts, totals, and the next deadline.

clearing_period
ClearingPeriodResponse · object
required

The clearing period details.

message_count
integer
required

Number of EDIFACT messages exchanged for this period.

Example:

5

objection_count
integer
required

Number of objections filed for this period.

Examples:

0

2

settlement_count
integer
required

Number of daily settlement records in this period.

Examples:

28

31

deadline_type
string | null

Type of the upcoming deadline: preliminary, objection, or final.

Example:

"preliminary"

total_imbalance_cost_eur
number | null

Total imbalance cost in EUR.

total_imbalance_mwh
number | null

Total imbalance energy in MWh.

upcoming_deadline
string | null

Next approaching deadline as ISO 8601 datetime.

Example:

"2026-02-25T23:59:59+01:00"