BRP Connect API

GET /v1/nominations

Die Nominierungen auflisten, auf die der angemeldete BKV Zugriff hat. Erforderlicher Scope: nominations:read

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

In: header

Query Parameters

status?string

Nach Nominierungsstatus filtern

Value in"pending" | "partial_match" | "match" | "superseded"
eic?string

Nach dem EIC-Code des Kunden 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_slots?string

Das Feld slots in die Antwort aufnehmen (Voreinstellung false). Bei false entfällt das Feld.

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/nominations?status=pending&eic=11YDIREKTVERM--A&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_slots=true&limit=10&after=con_a1b2c3d4"
{
  "nominations": [
    {
      "id": "nom_t4u5v6w7x8",
      "status": "match",
      "version": 2,
      "previous_nomination_id": "nom_s3t4u5v6w7",
      "gate_closure": "2026-07-14T12:30:00Z",
      "confirmed_at": "2026-07-14T12:45:00Z",
      "direction": "out",
      "eic": "11YDIREKTVERM--A",
      "tso": "DE_TENNET",
      "sent_at": "2026-07-14T12:20:00Z",
      "counterparty": {
        "name": "OTARK-CLEARING",
        "eic": "11Y0-0000-3333-F"
      },
      "slots": [
        {
          "delivery_start": "2026-07-15T11:00:00Z",
          "delivery_end": "2026-07-15T11:15:00Z",
          "slot_number": 53,
          "amount": 1.563,
          "matched_amount": 1.563
        }
      ],
      "created_at": "2026-07-14T10:30:00Z"
    }
  ],
  "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."
}