Reporting API

GET /v1/portfolios

Die Portfolios des angemeldeten Teilnehmers auflisten. Ein Portfolio ist die Einheit, an der der Verbrauchsabgleich gemessen wird; die dahinterliegende Zielkurve wird je Viertelstunde geführt, nach außen gibt es aber nur die Stunde — die API liefert nie Viertelstundenwerte. 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
X-Api-Key<token>

In: header

Query Parameters

limit?integer

Höchstzahl der Einträge pro Seite

Default10
Range1 <= value <= 100
after?string

Cursor für die nächste Seite — den Wert next_cursor aus der vorherigen Antwort übergeben

Response Body

curl -X GET "https://api.otark.energy/v1/portfolios?limit=10&after=pf_a1b2c3d4"

{
  "portfolios": [
    {
      "id": "pf_8k3d92hs",
      "name": "Werk Nord",
      "target_curve_source": "metering_data",
      "created_at": "2026-01-05T09:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

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