BRP Connect API

GET /v1/contracts

Die Verträge auflisten, auf die der angemeldete BKV Zugriff hat. Filterbar nach Status, Typ, EIC-Code, Lieferzeitraum und dem Tag, an dem der Vertrag gilt. Erforderlicher Scope: contracts:read

Als Markdown anzeigen
GET
/v1/contracts
X-Api-Key<token>

In: header

Query Parameters

status?string

Nach Vertragsstatus filtern

Value in"pending" | "in_progress" | "completed"
type?string

Nach Vertragstyp filtern; Einzelverträge tragen ppa

Value in"ppa" | "day_ahead" | "intraday"
eic?string

Nach dem EIC-Code des Käufers oder Verkäufers filtern

delivery_start?string

Filter: Lieferbeginn >= diesem Wert (ISO 8601)

Formatdate-time
delivery_end?string

Filter: Lieferende <= diesem Wert (ISO 8601)

Formatdate-time
active_on?string

Verträge filtern, die an diesem Tag gültig sind

Formatdate
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/contracts?status=pending&type=ppa&eic=11YSTADTWERKE--Z&delivery_start=2026-06-30T22%3A00%3A00Z&delivery_end=2026-09-30T22%3A00%3A00Z&active_on=2026-07-15&limit=10&after=con_a1b2c3d4"
{
  "contracts": [
    {
      "id": "con_a1b2c3d4",
      "external_id": "7K2QP",
      "type": "ppa",
      "status": "in_progress",
      "delivery_start": "2026-06-30T22:00:00Z",
      "delivery_end": "2026-09-30T22:00:00Z",
      "seller": {
        "name": "Stadtwerke",
        "eic": "11YSTADTWERKE--Z",
        "tso": "DE_TENNET"
      },
      "buyer": {
        "name": "Stadtwerke",
        "eic": "11YSTADTWERKE--Z",
        "tso": "DE_TENNET"
      },
      "ppa_type": "indexed",
      "period": "Q3-2026",
      "delivery_profile": "ENWEX Solar DE",
      "asset": {
        "id": "ast_w1x2y3z4",
        "name": "Solar Park SP-1",
        "nominal_power": 10,
        "technology": "solar",
        "tso": "DE_TENNET"
      },
      "created_at": "2026-05-12T08:42:17Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true,
    "next_cursor": "txn_k8m2p4q7r1"
  }
}

{
  "type": "https://brp.otark.energy/errors/validation",
  "title": "Validierung fehlgeschlagen",
  "status": 400,
  "instance": "/v1/customers/cust_r8s9t0u1",
  "errors": [
    {
      "field": "balance_group.tso",
      "code": "invalid_enum_value",
      "message": "Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'"
    }
  ]
}

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

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