Create Schedule

curl --request POST \
  --url https://api.engrate.io/schedule-management/v1/schedules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver_id": "<string>",
  "series": [
    {
      "data": [
        {
          "amount": 0,
          "ts": "2023-11-07T05:31:56Z"
        }
      ],
      "ids": {
        "in_area": "<string>",
        "in_party": "<string>",
        "out_area": "<string>",
        "out_party": "<string>",
        "market_agreement_id": "<string>"
      }
    }
  ],
  "tso": "<string>",
  "date": "2023-12-25",
  "test": false
}
'

import requests

url = "https://api.engrate.io/schedule-management/v1/schedules"

payload = {
    "receiver_id": "<string>",
    "series": [
        {
            "data": [
                {
                    "amount": 0,
                    "ts": "2023-11-07T05:31:56Z"
                }
            ],
            "ids": {
                "in_area": "<string>",
                "in_party": "<string>",
                "out_area": "<string>",
                "out_party": "<string>",
                "market_agreement_id": "<string>"
            }
        }
    ],
    "tso": "<string>",
    "date": "2023-12-25",
    "test": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    receiver_id: '<string>',
    series: [
      {
        data: [{amount: 0, ts: '2023-11-07T05:31:56Z'}],
        ids: {
          in_area: '<string>',
          in_party: '<string>',
          out_area: '<string>',
          out_party: '<string>',
          market_agreement_id: '<string>'
        }
      }
    ],
    tso: '<string>',
    date: '2023-12-25',
    test: false
  })
};

fetch('https://api.engrate.io/schedule-management/v1/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engrate.io/schedule-management/v1/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'receiver_id' => '<string>',
    'series' => [
        [
                'data' => [
                                [
                                                                'amount' => 0,
                                                                'ts' => '2023-11-07T05:31:56Z'
                                ]
                ],
                'ids' => [
                                'in_area' => '<string>',
                                'in_party' => '<string>',
                                'out_area' => '<string>',
                                'out_party' => '<string>',
                                'market_agreement_id' => '<string>'
                ]
        ]
    ],
    'tso' => '<string>',
    'date' => '2023-12-25',
    'test' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engrate.io/schedule-management/v1/schedules"

	payload := strings.NewReader("{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engrate.io/schedule-management/v1/schedules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engrate.io/schedule-management/v1/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}"

response = http.request(request)
puts response.read_body

{
  "acceptance_level": "cnf",
  "created_ts": "2026-03-25T14:00:00+00:00",
  "is_active": true,
  "last_modified_ts": "2026-03-25T14:05:00+00:00",
  "message_id": "MSG-20260325-001_v1",
  "org_uid": "9b2e4d8f-1c3a-4f5e-8d7b-6a9e0f2c1b3d",
  "schedule_uid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "spec": {
    "market": "DE",
    "receiver_id": "10XDE-VE-TRANSMK",
    "sender_id": "11XDE-SENDER---A",
    "series": [],
    "tso": "50HERTZ_DE_TSO"
  },
  "status": "cnf",
  "uid": "c8d7e6f5-4a3b-4c2d-9e1f-0a8b7c6d5e4f",
  "version": 1
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Schedule Management

Create Schedule

Create a Schedule or replace the desired spec of an existing one.

Records the submitted time series as the schedule’s desired spec, keyed on organization, scheduling area (derived from tso), and delivery date. Re-posting the same key overwrites the spec (last write wins); the returned uid/schedule_uid identify the schedule either way.

The delivery date is taken from date, or derived from the first series timestamp (UTC -> market-local midnight) when omitted. Series data must cover the full delivery day on the 15-minute grid (96 intervals, 92 on the spring DST day, 100 on the fall DST day). The legacy test flag is accepted but has no effect: this endpoint records the spec and does not submit to the TSO.

POST

schedule-management

schedules

Create Schedule

curl --request POST \
  --url https://api.engrate.io/schedule-management/v1/schedules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver_id": "<string>",
  "series": [
    {
      "data": [
        {
          "amount": 0,
          "ts": "2023-11-07T05:31:56Z"
        }
      ],
      "ids": {
        "in_area": "<string>",
        "in_party": "<string>",
        "out_area": "<string>",
        "out_party": "<string>",
        "market_agreement_id": "<string>"
      }
    }
  ],
  "tso": "<string>",
  "date": "2023-12-25",
  "test": false
}
'

import requests

url = "https://api.engrate.io/schedule-management/v1/schedules"

payload = {
    "receiver_id": "<string>",
    "series": [
        {
            "data": [
                {
                    "amount": 0,
                    "ts": "2023-11-07T05:31:56Z"
                }
            ],
            "ids": {
                "in_area": "<string>",
                "in_party": "<string>",
                "out_area": "<string>",
                "out_party": "<string>",
                "market_agreement_id": "<string>"
            }
        }
    ],
    "tso": "<string>",
    "date": "2023-12-25",
    "test": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    receiver_id: '<string>',
    series: [
      {
        data: [{amount: 0, ts: '2023-11-07T05:31:56Z'}],
        ids: {
          in_area: '<string>',
          in_party: '<string>',
          out_area: '<string>',
          out_party: '<string>',
          market_agreement_id: '<string>'
        }
      }
    ],
    tso: '<string>',
    date: '2023-12-25',
    test: false
  })
};

fetch('https://api.engrate.io/schedule-management/v1/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.engrate.io/schedule-management/v1/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'receiver_id' => '<string>',
    'series' => [
        [
                'data' => [
                                [
                                                                'amount' => 0,
                                                                'ts' => '2023-11-07T05:31:56Z'
                                ]
                ],
                'ids' => [
                                'in_area' => '<string>',
                                'in_party' => '<string>',
                                'out_area' => '<string>',
                                'out_party' => '<string>',
                                'market_agreement_id' => '<string>'
                ]
        ]
    ],
    'tso' => '<string>',
    'date' => '2023-12-25',
    'test' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.engrate.io/schedule-management/v1/schedules"

	payload := strings.NewReader("{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.engrate.io/schedule-management/v1/schedules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.engrate.io/schedule-management/v1/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"receiver_id\": \"<string>\",\n  \"series\": [\n    {\n      \"data\": [\n        {\n          \"amount\": 0,\n          \"ts\": \"2023-11-07T05:31:56Z\"\n        }\n      ],\n      \"ids\": {\n        \"in_area\": \"<string>\",\n        \"in_party\": \"<string>\",\n        \"out_area\": \"<string>\",\n        \"out_party\": \"<string>\",\n        \"market_agreement_id\": \"<string>\"\n      }\n    }\n  ],\n  \"tso\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"test\": false\n}"

response = http.request(request)
puts response.read_body

{
  "acceptance_level": "cnf",
  "created_ts": "2026-03-25T14:00:00+00:00",
  "is_active": true,
  "last_modified_ts": "2026-03-25T14:05:00+00:00",
  "message_id": "MSG-20260325-001_v1",
  "org_uid": "9b2e4d8f-1c3a-4f5e-8d7b-6a9e0f2c1b3d",
  "schedule_uid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "spec": {
    "market": "DE",
    "receiver_id": "10XDE-VE-TRANSMK",
    "sender_id": "11XDE-SENDER---A",
    "series": [],
    "tso": "50HERTZ_DE_TSO"
  },
  "status": "cnf",
  "uid": "c8d7e6f5-4a3b-4c2d-9e1f-0a8b7c6d5e4f",
  "version": 1
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

Request body for creating a schedule or a new spec for an existing one.

market

enum<string>

required

Electricity market: DE/germany or NL/netherlands.

Available options:

DE,

NL,

germany,

netherlands

receiver_id

string

required

EIC X code (DE) or EAN-13 (NL) of the receiving TSO.

Minimum string length: 1

series

ScheduleCreateSeriesItem · object[]

required

Time series to submit (0-50). NL allows an empty list; DE requires at least one series.

Maximum array length: 50

Show child attributes

tso

string

required

TSO identifier. DE: 50HERTZ_DE_TSO, DE-AMPRION-TSO, TTG_DE, DE-TRANSNETBWTSO. NL: TENNET_TSO.

Minimum string length: 1

date

string<date> | null

Delivery date (YYYY-MM-DD). If omitted, derived from the first timestamp in series data (UTC -> market-local midnight).

test

boolean

default:false

Legacy gate-closure bypass flag. Accepted for wire compatibility; this endpoint records the desired spec and does not submit, so it has no effect.

Response

Successful Response

A Schedule Version representing one submission attempt. Each re-submission creates a new version.

acceptance_level

string

required

Highest acceptance level reached: empty string, ack, ano, par, or cnf.

Examples:

"cnf"

"ack"

""

created_ts

string

required

ISO 8601 datetime when this version was created.

Example:

"2026-03-25T14:00:00+00:00"

last_modified_ts

string

required

ISO 8601 datetime of the most recent status change.

Example:

"2026-03-25T14:05:00+00:00"

org_uid

string

required

Organization that owns this version.

Example:

"9b2e4d8f-1c3a-4f5e-8d7b-6a9e0f2c1b3d"

schedule_uid

string

required

Parent Schedule identifier.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

spec

ScheduleVersionSpec · object

required

Full submission specification including market routing and series references.

Show child attributes

status

string

required

Processing status. created before submission, then the verbatim market status: submitted, ack_positive, ack_negative, ack_partial, icnf, dacnf, cnf, cnf_partial, or fcnf.

Examples:

"cnf"

"submitted"

"ack_negative"

uid

string

required

Unique identifier for this version.

Example:

"c8d7e6f5-4a3b-4c2d-9e1f-0a8b7c6d5e4f"

version

integer

required

Sequential version number (1-based). Increments with each re-submission.

Examples:

1

2

3

is_active

boolean

default:true

Whether this is the active version: the latest version the TSO has accepted, the one it currently treats as binding. Rejected or not-yet-answered versions are not active, and a later rejected version never replaces an accepted earlier one.

message_id

string | null

TSO document identification assigned to this version's message.

Example:

"MSG-20260325-001_v1"

nrr_received

boolean | null

Whether a Non-Repudiation of Receipt (NRR) delivery confirmation has been received from the TSO.

transmission_report_id

string | null

Mako365/AS4 transmission report identifier for delivery tracking.

Example:

"TR-20260325-001"

warnings

WarningItem · object[] | null

TSO warnings from the ACK response, if any.

Show child attributes

Core

Cost of Energy

Schedule Management

Portfolio Forecasts

Settlement Management (MaBiS)

Create Schedule

Authorizations

Body

Response