BRP Connect API

GET /v1/transactions

Alle Transaktionen des BKV auflisten, aus Einzelverträgen und aus Green SPOT. Nimmt dieselben Filter entgegen wie der vertragsbezogene Endpunkt, zusätzlich die Filter contract_id und type. Erforderlicher Scope: transactions:read

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

In: header

Query Parameters

contract_id?string

Nach Vertrag filtern

type?string

Nach Transaktionstyp filtern

Value in"ppa" | "day_ahead"
status?string

Nach Transaktionsstatus filtern

Value in"valid" | "invalid" | "superseded"
sender_eic?string

Nach dem EIC-Code des Senders filtern

receiver_eic?string

Nach dem EIC-Code des Empfängers filtern

delivery_date?string

Nach Liefertag filtern (Kurzform für einen ganzen Tag)

Formatdate
delivery_start?string

Filter: Lieferbeginn >= diesem Wert (ISO 8601)

Formatdate-time
delivery_end?string

Filter: Lieferende <= diesem Wert (ISO 8601)

Formatdate-time
slot_number_from?integer

Filter: Nummer der Zeitscheibe >= diesem Wert (1–100)

Range1 <= value <= 100
slot_number_to?integer

Filter: Nummer der Zeitscheibe <= diesem Wert (1–100)

Range1 <= value <= 100
include_assets?string

Ein bereinigtes Feld assets in die Antwort aufnehmen, das alle von den gelieferten Transaktionen referenzierten Anlagen enthält

Default"false"
Value in"true" | "false"
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/transactions?contract_id=con_a1b2c3d4&type=ppa&status=valid&sender_eic=11YDIREKTVERM--A&receiver_eic=11YSTADTWERKE--Z&delivery_date=2026-07-15&delivery_start=2026-06-30T22%3A00%3A00Z&delivery_end=2026-09-30T22%3A00%3A00Z&slot_number_from=1&slot_number_to=1&include_assets=true&limit=10&after=con_a1b2c3d4"
{
  "transactions": [
    {
      "id": "txn_k8m2p4q7r1",
      "type": "ppa",
      "contract_id": "con_a1b2c3d4",
      "status": "valid",
      "version": 2,
      "previous_transaction_id": "txn_j5n3w8v2x6",
      "sender": {
        "eic": "11YDIREKTVERM--A",
        "asset_id": "ast_w1x2y3z4",
        "tso": "DE_TENNET"
      },
      "receiver": {
        "eic": "11YSTADTWERKE--Z",
        "tso": "DE_TENNET"
      },
      "delivery_start": "2026-07-15T11:00:00Z",
      "delivery_end": "2026-07-15T11:15:00Z",
      "slot_number": 53,
      "volume": 1.563,
      "created_at": "2026-07-14T10:30:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true,
    "next_cursor": "txn_k8m2p4q7r1"
  },
  "assets": [
    {
      "id": "ast_w1x2y3z4",
      "name": "Solar Park SP-1",
      "nominal_power": 10,
      "technology": "solar",
      "tso": "DE_TENNET"
    }
  ]
}

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