Skip to main content
POST
Submit the portfolio forecast for one delivery day

Authorizations

X-API-Key
string
header
required

Body

application/json

Portfolio forecast for one delivery day: production and consumption time series per control area (or per market location).

delivery_day
string<date>
required

The day the energy is delivered (YYYY-MM-DD, a Europe/Berlin calendar day)

series
ForecastSeries · object[]
required

The day's series. Several series per area and kind are allowed and summed; omitted control areas count as zero

Minimum array length: 1
unit
enum<string>
default:MW

MW: average power per quarter-hour (default). MWH: energy per quarter-hour

Available options:
MW,
MWH
malo_mapping
Malo Mapping · object | null

MaLo -> control area mapping; required if any series is tagged by MaLo

validate_only
boolean
default:false

True runs the full validation and returns the acknowledgment with its totals - but stores nothing and starts nothing. Safe for integration testing against the live service; the returned input_hash equals the one a real submission of the same payload would get

Response

Successful Response

Acknowledgment of an accepted forecast submission, including the total daily volumes as received and a reference for the submission.

delivery_day
string<date>
required
interval_count
integer
required

Quarter-hours the delivery day has (96 / 92 / 100)

series_received
integer
required
total_production_mwh
number
required

Total production energy submitted for the delivery day, in MWh - compare against your own daily total as a plausibility check

total_consumption_mwh
number
required

Total consumption energy submitted for the delivery day, in MWh - compare against your own daily total as a plausibility check

input_hash
string
required

Content hash of the submission - quote it when asking about a delivery day; identical payloads produce identical hashes

status
enum<string>
default:received

received: stored, the pipeline picks the day up. validated: the payload passed every check but nothing was stored (validate_only was true)

Available options:
received,
validated