Zum Hauptinhalt springen
GET
/
v1
/
contracts
List contracts
curl --request GET \
  --url https://api.otark.energy/v1/contracts \
  --header 'X-Api-Key: <api-key>'
{
  "contracts": [
    {
      "id": "con_a1b2c3d4",
      "external_id": "PPA-2025-0042",
      "type": "ppa",
      "status": "in_progress",
      "delivery_start": "2026-01-01T00:00:00Z",
      "delivery_end": "2026-03-31T23:45:00Z",
      "seller": {
        "name": "GreenCo Energy BV",
        "eic": "11YGREENENERGY-Z",
        "tso": "TenneT"
      },
      "buyer": {
        "name": "GreenCo Energy BV",
        "eic": "11YGREENENERGY-Z",
        "tso": "TenneT"
      },
      "created_at": "2024-11-20T10:00:00Z",
      "updated_at": "2025-01-05T08:30:00Z",
      "ppa_type": "indexed",
      "period": "Q1-2026",
      "delivery_profile": "ENWEX Solar 2026",
      "asset": {
        "id": "ast_w1x2y3z4",
        "name": "Zonnepark De Wilgen",
        "nominal_power": 25,
        "technology": "solar",
        "tso": "TenneT"
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true
  }
}

Autorisierungen

X-Api-Key
string
header
erforderlich

Abfrageparameter

status
enum<string>

Filter by contract status

Verfügbare Optionen:
pending,
in_progress,
completed
type
enum<string>

Filter by contract type

Verfügbare Optionen:
ppa,
day_ahead,
intraday
eic
string

Filter by buyer or seller EIC code

Beispiel:

"11YGREENENERGY-Z"

delivery_start
string<date-time>

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

Beispiel:

"2026-01-01T00:00:00Z"

delivery_end
string<date-time>

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

Beispiel:

"2026-03-31T23:45:00Z"

active_on
string<date>

Filter contracts active on this date

Beispiel:

"2026-01-15"

limit
integer
Standard:10

Maximum number of items per page

Erforderlicher Bereich: 1 <= x <= 100
after
string

Return records after this ID (cursor-based pagination)

Beispiel:

"con_a1b2c3d4"

Antwort

Contracts list

contracts
object[]
erforderlich

List of contracts

pagination
object
erforderlich