Reporting API

GET /v1/portfolios/{portfolio_id}/coverage-matching/{month}

Der Verbrauchsabgleich eines Portfolios für einen Liefermonat, stundenscharf. Je Stunde setzt der Report die HC und Ansprüche des Käufers gegen die Zielkurve: gedeckt, Unterdeckung und Überdeckung. Überdeckung wird nie in eine andere Stunde übertragen — eine Überschussstunde füllt keine Fehlstunde. Der Report ist produktneutral: HC aus 1-Click PPA zählen ebenso wie HC und Ansprüche aus Green SPOT, vor dem Monatsabschluss als Anspruch. Fehlt ein Viertelstundenwert der Zielkurve, rechnet OES die Stunde mit den vorliegenden Viertelstunden. Ohne Zielkurve weist der Report allein die Zertifikatskurve aus; target_curve_mwh, covered_mwh, under_coverage_mwh und over_coverage_mwh sind dann null. Die Stundenwerte sind laufend abrufbar, sobald sie entstehen. 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/portfolios/{portfolio_id}/coverage-matching/{month}
X-Api-Key<token>

In: header

Path Parameters

portfolio_idstring

Kennung des Portfolios

monthstring

Liefermonat (YYYY-MM)

Match^\d{4}-(0[1-9]|1[0-2])$

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/portfolios/pf_8k3d92hs/coverage-matching/2026-03?format=json"

{
  "portfolio_id": "pf_8k3d92hs",
  "month": "2026-03",
  "hours": [
    {
      "date": "2026-03-18",
      "hour": 14,
      "hour_suffix": null,
      "target_curve_mwh": 30,
      "hc_held_mwh": 30.5,
      "covered_mwh": 30,
      "under_coverage_mwh": 0,
      "over_coverage_mwh": 0.5
    },
    {
      "date": "2026-03-18",
      "hour": 15,
      "hour_suffix": null,
      "target_curve_mwh": 30,
      "hc_held_mwh": 28.5,
      "covered_mwh": 28.5,
      "under_coverage_mwh": 1.5,
      "over_coverage_mwh": 0
    },
    {
      "date": "2026-03-18",
      "hour": 16,
      "hour_suffix": null,
      "target_curve_mwh": 30,
      "hc_held_mwh": 31,
      "covered_mwh": 30,
      "under_coverage_mwh": 0,
      "over_coverage_mwh": 1
    }
  ],
  "totals": {
    "target_curve_mwh": 90,
    "hc_held_mwh": 90,
    "covered_mwh": 88.5,
    "under_coverage_mwh": 1.5,
    "over_coverage_mwh": 1.5
  }
}

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