Reporting API

GET /v1/proofs/annual/{year}

Der Jahresnachweis des angemeldeten Teilnehmers, einmal jährlich zum 31. März des Folgejahres erstellt, in denselben Formaten wie die Monatsreports. Er trägt die Jahres-Zeitreihe aus 8.760 Stundenwerten (8.784 im Schaltjahr), produktneutral über Green SPOT und 1-Click PPA hinweg, mit den Summen je Ausweisung, der entwerteten HKN-Menge des Jahres und den im Dezember-Clearing als Backup gelieferten HKN. Solange der Nachweis des angefragten Jahres nicht erstellt ist, antwortet die Route mit 404. Eine PDF-Fassung für Prüfer liefert die Anfrage mit Accept: application/pdf. 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/proofs/annual/{year}
X-Api-Key<token>

In: header

Path Parameters

yearinteger

Kalenderjahr (YYYY)

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/proofs/annual/2026?format=json"

{
  "year": 2026,
  "hours": [
    {
      "date": "2026-03-18",
      "hour": 14,
      "hour_suffix": null,
      "positions": [
        {
          "quantity_mwh": 16,
          "disclosure": "covered_go_backed",
          "coverage_source": "coupled",
          "asset": {
            "id": "ast_7p2q9r4s",
            "mastr_number": "SEE941280003651",
            "name": "WEA Nord 1",
            "technology": "wind_onshore",
            "location": "Windparkstraße 1, 25813 Husum, DE",
            "commissioning_date": "2019-06-27"
          },
          "cause": null
        },
        {
          "quantity_mwh": 13.5,
          "disclosure": "covered_go_backed",
          "coverage_source": "coupled",
          "asset": {
            "id": "ast_3f8b1c6d",
            "mastr_number": "SEE905467231018",
            "name": "PV Süd 2",
            "technology": "solar",
            "location": "Industriestraße 5, 84028 Landshut, DE",
            "commissioning_date": "2021-04-30"
          },
          "cause": null
        },
        {
          "quantity_mwh": 0.5,
          "disclosure": "not_green_covered",
          "coverage_source": null,
          "asset": null,
          "cause": "coverage_gap"
        }
      ]
    }
  ],
  "totals": {
    "covered_go_backed_mwh": 1385,
    "allocated_go_pending_mwh": 0,
    "not_green_covered_mwh": 24,
    "uncovered_mwh": 5
  },
  "go_cancelled_mwh": 1385,
  "rounding_offsets": [
    {
      "quantity_mwh": 1,
      "source_asset": {
        "id": "ast_3f8b1c6d",
        "mastr_number": "SEE905467231018",
        "name": "PV Süd 2",
        "technology": "solar",
        "location": "Industriestraße 5, 84028 Landshut, DE",
        "commissioning_date": "2021-04-30"
      }
    }
  ]
}

{
  "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."
}

{
  "type": "https://api.otark.energy/errors/portfolio_not_found",
  "title": "Portfolio nicht gefunden",
  "status": 404,
  "instance": "/v1/portfolios/pf_8k3d92hs"
}

/proofs/green-spot/{month} GET

Das Green-SPOT-Nachweispaket eines Liefermonats: die stundenscharfe HC-Zeitreihe mit der Ausweisung je Menge, der Deckungsquelle (coupled aus dem Bündel aus Strom und QHC, time_matched aus dem Granular Matching) und der Anlagenzuordnung je Stunde, dazu datierte Nachträge, als Backup gelieferte HKN und die entwertete HKN-Menge. Ab D+1 liefert der Report vorläufige Stundenwerte aus Messwerten und Verkäufermeldung, die Mengen als Anspruch mit ausstehender Zuteilung. Mit dem Monatsabschluss am 10. des übernächsten Monats teilt OES die HC und HKN je Stunde und Anlage zu, und der Nachweis des Monats ist final. Weil der HKN-Übertrag je Käufer über alle Anlagen abgerundet wird, können HKN und GC auf Bruchteilsebene aus verschiedenen Anlagen stammen. Was fehlt, weist der Nachweis aus und ersetzt es nicht; die Ursache steht je Menge dabei. Eine PDF-Fassung für Prüfer liefert die Anfrage mit Accept: application/pdf. Erforderlicher Scope: proofs:read

/fractional-account GET

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