Reporting API

GET /v1/fractional-account

Den aktuellen Restsaldo des angemeldeten Teilnehmers abrufen: die Differenz zwischen seinem GCR-Konto bei OES (drei Nachkommastellen) und den auf sein HKNR-Konto übertragenen HKN (ganze HKN) im laufenden Kalenderjahr. Im Monatsabschluss überträgt OES die abgerundete kumulierte GC-Menge des Jahres abzüglich der schon übertragenen HKN, je Käufer über alle Anlagen; der Rest rollt in den Folgemonat. Mit dem Dezember-Abschluss am 10. Februar erhält der Käufer für den offenen Restsaldo den Jahresreferenzpreis P_year in bar, oder OES liefert als Backup einen HKN desselben Erzeugungsmonats aus einer anderen Anlage; ein unterjährig ausgeschiedener Käufer ebenso. Einen Verfall gibt es nicht. Erforderlicher Scope: proofs:read

Als Markdown anzeigen

Freischaltung erforderlich

Diese API muss für Ihr Konto explizit freigeschaltet werden. Wenden Sie sich dazu an den Support.
GET
/v1/fractional-account
X-Api-Key<token>

In: header

Query Parameters

format?string

Antwortformat: json (Voreinstellung) liefert den Report als strukturiertes JSON, csv denselben Inhalt als CSV (text/csv). Die drei Wege tragen denselben Inhalt — sie unterscheiden sich nur darin, wer sie liest.

Default"json"
Value in"json" | "csv"

Response Body

curl -X GET "https://api.otark.energy/v1/fractional-account?format=json"

{
  "total_carry_forward_mwh": 0.4
}

{
  "type": "https://api.otark.energy/errors/validation",
  "title": "Validierung fehlgeschlagen",
  "status": 400,
  "instance": "/v1/proofs/green-spot/2026-3",
  "errors": [
    {
      "field": "month",
      "code": "invalid_format",
      "message": "Invalid month format. Expected YYYY-MM, received '2026-3'"
    }
  ]
}

{
  "type": "https://api.otark.energy/errors/invalid_api_key",
  "title": "Ungültiger API-Schlüssel",
  "status": 401
}

{
  "type": "https://api.otark.energy/errors/insufficient_scopes",
  "title": "Unzureichende Scopes des API-Schlüssels",
  "status": 403,
  "detail": "Missing scope: proofs:read. Please create a new API key with the required scopes."
}