Get startedPPA Marketplace1-Click PPAGreen SPOTGranular certificatesSettlementDeveloper resourcesHelp & Support
Contact Support
BRP Connect APINominations

List nominations

List nominations accessible to the authenticated BRP. Required scope: nominations:read

GET
/v1/nominations

Authorization

X-Api-Key<token>

In: header

Query Parameters

status?string

Filter by nomination status

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

Filter by customer EIC code

delivery_date?string

Filter by delivery date (shorthand for full-day range)

Formatdate
delivery_start?string

Filter: delivery start >= this value (ISO 8601)

Formatdate-time
delivery_end?string

Filter: delivery end <= this value (ISO 8601)

Formatdate-time
slot_number_from?integer

Filter: slot number >= this value (1–100)

Range1 <= value <= 100
slot_number_to?integer

Filter: slot number <= this value (1–100)

Range1 <= value <= 100
include_slots?string

Include the slots array in the response (default false). When false, the slots field is omitted.

Default"false"
Value in"true" | "false"
limit?integer

Maximum number of items per page

Default10
Range1 <= value <= 100
after?string

Cursor for the next page — pass the next_cursor value from the previous response

Response Body

curl -X GET "https://api.otark.energy/v1/nominations?status=pending&eic=11YWINDPARKNO--A&delivery_date=2026-01-15&delivery_start=2026-01-01T00%3A00%3A00Z&delivery_end=2026-03-31T23%3A45%3A00Z&slot_number_from=1&slot_number_to=1&include_slots=true&limit=10&after=con_a1b2c3d4"
{
  "nominations": [
    {
      "id": "nom_t4u5v6w7x8",
      "status": "match",
      "version": 1,
      "previous_nomination_id": null,
      "gate_closure": "2026-01-14T14:30:00Z",
      "confirmed_at": "2026-01-14T15:00:00Z",
      "direction": "out",
      "eic": "11YWINDPARKNO--A",
      "tso": "DE_TENNET",
      "sent_at": "2026-01-14T14:35:00Z",
      "counterparty": {
        "name": "Otark",
        "eic": "11YOTARK------Z"
      },
      "slots": [
        {
          "delivery_start": "2026-01-15T14:00:00Z",
          "delivery_end": "2026-01-15T14:15:00Z",
          "slot_number": 57,
          "amount": 12.5,
          "matched_amount": 12.5
        }
      ],
      "created_at": "2026-01-14T14:30:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true,
    "next_cursor": "txn_k8m2p4q7r1"
  }
}

{
  "type": "https://brp.otark.team/errors/validation",
  "title": "Validation Failed",
  "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.team/errors/invalid_api_key",
  "title": "Invalid API Key",
  "status": 401
}

{
  "type": "https://brp.otark.team/errors/insufficient_scopes",
  "title": "Insufficient API Key Scopes",
  "status": 403,
  "detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}

Bulk get transactions (POST) POST

Retrieve multiple transactions by ID using a request body. Use this for large ID sets that exceed the GET query parameter limit. Non-existent or inaccessible IDs are silently omitted. Required scope: transactions:read

Get nomination GET

Retrieve a single nomination with its counterparties and slots. Required scope: nominations:read