Zum Hauptinhalt springen
GET
Get contract

Autorisierungen

X-Api-Key
string
header
erforderlich

Pfadparameter

contract_id
string
erforderlich

Contract identifier

Beispiel:

"con_a1b2c3d4"

Antwort

Contract details

An energy contract. Contracts are polymorphic — the schema varies by type.

id
string
erforderlich

Internal unique contract identifier

Beispiel:

"con_a1b2c3d4"

external_id
string
erforderlich

External reference identifier

Beispiel:

"PPA-2025-0042"

type
enum<string>
erforderlich

Contract type

Verfügbare Optionen:
ppa,
day_ahead,
intraday
Beispiel:

"ppa"

status
enum<string>
erforderlich

Contract status

Verfügbare Optionen:
pending,
in_progress,
completed
Beispiel:

"in_progress"

delivery_start
string<date-time> | null
erforderlich

ISO 8601 delivery start (UTC)

Beispiel:

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

delivery_end
string<date-time> | null
erforderlich

ISO 8601 delivery end (UTC)

Beispiel:

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

seller
object
erforderlich

A counterparty identified by EIC code

buyer
object
erforderlich

A counterparty identified by EIC code

created_at
string<date-time> | null
erforderlich

ISO 8601 creation timestamp

Beispiel:

"2024-11-20T10:00:00Z"

ppa_type
enum<string> | null

PPA pricing/delivery type (only present when type is ppa)

Verfügbare Optionen:
forecasted,
produced,
consumed,
baseload,
shaped,
peakload,
indexed
Beispiel:

"indexed"

period
string | null

Contract period display name (only present when type is ppa)

Beispiel:

"Q1-2026"

delivery_profile
string | null

Delivery profile name (only present when type is ppa)

Beispiel:

"ENWEX Solar 2026"

asset
object

The generating asset (only present when type is ppa and an asset is assigned)