POST
/
v1
/
bidding-zones
/
{bidding_zone_id}
/
control
Control a bidding zone
curl --request POST \
  --url https://api.amberflow.io/v1/bidding-zones/{bidding_zone_id}/control \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "time_from": "2025-05-13T11:52:00+00:00",
  "time_to": "2025-05-13T12:52:00+00:00",
  "type": "MAX_CONSUMPTION"
}'
{
  "id": "ctrl_test8j9ahjsdf",
  "created_at": "2025-05-13T11:52:00+00:00",
  "time_from": "2025-05-13T11:52:00+00:00",
  "time_to": "2025-05-13T12:52:00+00:00",
  "type": "MAX_PRODUCTION",
  "results": [
    {
      "time_from": "2025-05-13T11:52:00+00:00",
      "time_to": "2025-05-13T12:52:00+00:00",
      "isp": 1,
      "before": 100,
      "after": 10,
      "delta": -90
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
bidding_zone_id
string
required

Body

application/json
​
type
enum<string>
required
Available options:
MAX_PRODUCTION,
ZERO_EXPORT,
MAX_CONSUMPTION
Examples:

"MAX_CONSUMPTION"

​
time_from
string<date-time>

Start time of the curtailment. Will be rounded to the next full minute. If empty, the current minute will be used.

Examples:

"2025-05-13T11:52:00+00:00"

​
time_to
string<date-time>

End time of the curtailment. Will be rounded to the next full minute. If empty, the end of the current quarter will be used.

Examples:

"2025-05-13T12:52:00+00:00"

Response

Successful Response

​
id
string
required
Examples:

"ctrl_test8j9ahjsdf"

​
created_at
string<date-time>
required
Examples:

"2025-05-13T11:52:00+00:00"

​
time_from
string<date-time>
required
Examples:

"2025-05-13T11:52:00+00:00"

​
time_to
string<date-time>
required
Examples:

"2025-05-13T12:52:00+00:00"

​
type
enum<string>
required
Available options:
MAX_PRODUCTION,
ZERO_EXPORT,
MAX_CONSUMPTION
Examples:

"MAX_PRODUCTION"

"ZERO_EXPORT"

"MAX_CONSUMPTION"

​
results
ControlEffect · object[]
required