User Guide

API balancing capacity

 

 

 

Version 3.5

Effective date: May 31, 2021

 

 

 

 

 

 

 

 

 

 

 

 

Contents

1       Document history_ 5

2       Introduction_ 6

2.1      Definitions 6

2.2      Technical support 7

3       Functional description of the Balancing Capacity API 8

3.1      General description. 8

3.2      Prerequisites for using the APIs 8

3.2.1   Data confidentiality. 8

3.2.2   Termination. 8

3.3      "procured_reserves" resource. 8

3.4      "accepted_offers" resource. 8

3.5      "peak_daily_margins" resource. 8

3.6      "insufficients_offers" resource. 9

3.7      "imbalance" resource. 9

3.8      "individualoffers_energybids" resource. 9

3.9      "aggregatedoffers_energybids" resource. 9

3.10   "margins_data" resource. 9

3.11   "daily_procured_reserves" resource. 9

3.12   " tso_need_for_procured_reserves" resource. 9

4       Accessing the API 10

5       Resources exposed by the "Balancing Capacity" API 11

5.1      procured_reserves resource. 11

5.1.1   GET /procured_reserves. 11

5.1.1.1     Call methods. 11

5.1.1.2     Inputs. 11

5.1.1.3     Outputs. 12

5.1.1.4     Control rule. 14

5.1.1.5     Error codes. 14

5.2      accepted_offers resource. 15

5.2.1   GET Accepted/offers. 15

5.2.1.1     Call methods. 15

5.2.1.2     Inputs. 15

5.2.1.3     Outputs. 16

5.2.1.4     Control rule. 18

5.2.1.5     Error codes. 18

5.3      peak_daily_margins resource. 19

5.3.1   GET /peak_daily_margins. 19

5.3.1.1     Call methods. 19

5.3.1.2     Inputs. 19

5.3.1.3     Outputs. 20

5.3.1.4     Control rule. 24

5.3.1.5     Error codes. 24

5.4      insufficients_offers resource. 25

5.4.1   GET /insufficients_offers. 25

5.4.1.1     Call methods. 25

5.4.1.2     Inputs. 25

5.4.1.3     Outputs. 26

5.4.1.4     Control rule. 27

5.4.1.5     Error codes. 28

5.5      imbalance resource. 28

5.5.1   GET /imbalance. 28

5.5.1.1     Call methods. 28

5.5.1.2     Inputs. 29

5.5.1.3     Outputs. 29

5.5.1.4     Control rule. 31

5.5.1.5     Error codes. 31

5.6      individualoffers_energybids resource. 32

5.6.1   GET /individualoffers_energybids. 32

5.6.1.1     Call methods. 32

5.6.1.2     Inputs. 32

5.6.1.3     Outputs. 33

5.6.1.4     Control rule. 35

5.6.1.5     Error codes. 35

5.7      aggregatedoffers_energybids resource. 36

5.7.1   GET / aggregatedoffers_energybids. 36

5.7.1.1     Call methods. 36

5.7.1.2     Inputs. 36

5.7.1.3     Outputs. 37

5.7.1.4     Control rule. 41

5.7.1.5     Error codes. 42

5.8      margins_data resource. 42

5.8.1   GET /margins_data. 42

5.8.1.1     Call methods. 42

5.8.1.2     Inputs. 43

5.8.1.3     Outputs. 44

5.8.1.4     Control rule. 45

5.8.1.5     Error codes. 46

5.9      Daily_procured_reserves resource. 46

5.9.1   GET /daily_procured_reserves. 46

5.9.1.1     Call methods. 46

5.9.1.2     Inputs. 47

5.9.1.3     Outputs. 47

5.9.1.4     Control rule. 49

5.9.1.5     Error codes. 50

5.10   Tso_need_for_procured_reserves ressource. 50

5.10.1 GET /tso_need_for_procured_reserves. 50

5.10.1.1      Call methods. 50

5.10.1.2      Inputs. 50

5.10.1.3      Outputs. 51

5.10.1.4      Control rule. 52

5.10.1.5      Error codes. 52

6       Error details_ 54

6.1      Functional errors 55

6.1.1   procured_reserves. 55

6.1.2   accepted_offers. 56

6.1.3   peak_daily_margins. 57

6.1.4   insufficients_offers. 58

6.1.5   imbalance. 59

6.1.6   individualoffers_energybids. 60

6.1.7   aggregatedoffers_energybids. 61

6.1.8   margins_data. 63

6.1.9   daily_procured_reserves. 63

6.1.10 tso_need_for_procured_reserves. 64

6.2      Technical errors 65

7       Appendices_ 67

7.1      Sample files 67

END OF DOCUMENT_ 67


 

 

Version

Date

Notes

1.2

25/10/2017

API created

2.1

21/02/2018

Change made to the /peak_daily_margins resource: addition of the “forecast_type” field as additional output data.

3.0

21/02/2019

Output of the /peak_daily_margins resource transformed.

The new /imbalance resource created

3.1

03/05/2019

Added 4 new fields out of the /peak_daily_margins resource

è Minor version upgrade of the API : V3.1

3.2

11/02/2021

Creation of the 2 /individualoffers_energybids and /aggregatedoffers_energybids resources

è Minor version upgrade of the API : V3.2

3.3

29/03/2021

Deletion of 4 fields out of the /aggregatedoffers_energybids resource

è Minor version upgrade of the l’API : V3.3

3.4

06/04/2021

Creation of the /margins_data resource

è Minor version upgrade of the l’API : V3.4

3.5

29/04/2021

Creation of the 2 /daily_procured_reserves and /tso_need_for_procured_reserves resources

è Minor version upgrade of the l’API: V3.5

 

 

 

 

 

 

 

This document describes the first version of the Balancing Capacity API version 3 made available by RTE to its customers in order to expose the data relating to the balancing mechanism, as follows:

·         Procured balancing capacity,

·         Accepted offers,

·         Operating margins at peak demand,

·         Insufficient bid messages,

·         Provisional imbalance volume,

·         Offers submitted by the balancing service providers,

·         Offers submitted by the balancing service providers, summed and aggregated by type of reserve and type of offer.

·         Operating margin seen in real time

 

Reference documents

 

Short reference

Name of the document

Complete reference

[R1]

Terms of use for RTE’s APIs

Access link

2.1     Definitions

The terms used in the User Guide of which the first letter is capitalized are defined below or in the Terms & Conditions [R1]:

 

 

API

Application Programming Interface (Interface de programmation applicative)

Authentication

Protection Mode to ensure that the identity of the Sender or of the Receiver has been checked by RTE, and that they are authorized to access the IT system and use the Applications.

Sender

Party which sends a Message

Message 

Set of computer data used to transmit information, structured in accordance with a particular order that is specified in the User Guide. A Message can be sent by the User or by RTE.

Operation

An operation is how the customer interacts with the API resource. It is an http action (for example: GET for reading)

Party or Parties

Within the framework of the User Guide, these terms refer to either RTE or the User individually, or to both RTE and the User collectively.

Receiver

Party which receives the Sender's Message.

Resource

A resource represents the data on which the client application interacts.

URL

Uniform Resource Locator: character string based on a specific format used to locate a resource on a network and specify what protocol should be used on this resource.

User(s) 

Legal entity which has agreed to RTE’s General Terms and Conditions for using APIs and which has been granted access to RTE’s IT system for the purposes of using the APIs it has made available.

 

Translation of English values returned by the API:

 

English output value of the API

French translation

FCR

Frequency Containment Reserve

AFRR

Secondary reserve

MFRR

Quick reserve

RR

Additional reserve

UP_DOWN

On the upside and downside

UPWARD

On the upside

DOWNWARD

On the downside

MORNING

Morning

EVENING

Evening

DOWNGRADED

Degraded

WARNING

Alert

BALANCE_SUPPLY_DEMAND

Supply/demand balance

GRID

RSO (adjustments for handling network congestion)

2.2     Technical support

In the event of difficulties accessing or using an API, Users can contact the telephone support services provided by RTE in accordance with the technical conditions detailed in the General Terms and Conditions of Use.

 

 

 

 

3.1     General description

The API provides access to seven resources. These seven resources are only readable via an operation such as GET.

3.2     Prerequisites for using the APIs

The Balancing Capacity API is for players in the electricity market and the general public. Nevertheless, API users must create an account on RTE’s digital portal. Once they have set up an account, they will be able to get their Oauth 2.0 credentials. These identifiers are then required when calling the APIs.

3.2.1   Data confidentiality

The information contained in the messages may not be used for purposes other than those provided in the Terms & Conditions [R1].

3.2.2   Termination

Subscription to an API is automatically terminated when the user deletes their account on the Digital RTE portal.

Should the User wish to cease using an API without terminating their subscription, they simply need to stop sending calls to the API.

3.3     "procured_reserves" resource

This resource for obtaining data about procured balancing capacity. To ensure the balance between supply and demand, RTE contractualizes the availability of power balancing reserves to producers or even consumers.

·         Each producer must attend primary and secondary frequency settings adjusted under the conditions provided in the system service rules. The automatic reserve obligations issued by RTE result in a fixed compensation by RTE.

·         The tertiary reserve guarantee is the outcome of a call for tenders conducted in mid-January with producers and consumers. It guarantees a fixed annual volume of tertiary reserve that can be mobilized in 15 min (about 1,000 MW) and of tertiary reserve that can be mobilized in 30 minutes (approximately 500 MW) over a period from 1 April to 31 March. In return for their contractual commitment to the tertiary reserves, balancing parties receive an annual bonus based on the volume offered and the activation delay. The price displayed is an average of the annual bonus paid to the parties.

3.4     "accepted_offers" resource

This resource provides data on bids accepted by RTE. Submitted adjustment bids consistent with BRE/MA rules are accepted by RTE. Nonconforming submitted offers are refused. The volume of FRR and RR capacity bids will be provided in 2016.

3.5     "peak_daily_margins" resource

This resource provides the operating margin data for peak demand.

 

3.6     "insufficients_offers" resource

This resource provides data on insufficient offer messages for the balancing mechanism.

3.7     "imbalance" resource

This resource is for publishing a rolling provisional imbalance volume across the first five hours (expressed in megawatts per half hourly-increment) throughout the day, and a log of the last values published (made up of 48 half-hourly increments) at the end of the day.

3.8     "individualoffers_energybids" resource

This resource allows to obtain data relating to the offers submitted by balancing service providers. All the offers submitted by balancing service providers on the various market mechanisms are listed anonymously.

3.9     "aggregatedoffers_energybids" resource

This resource allows to obtain data relating to the offers submitted by balancing service providers, summed and aggregated by type of reserve and type of offer.

3.10 "margins_data" resource

This resource, allows to obtain data relative to required margins, available margins and forecasted imbalance, starting from the last calculation time until the rest of the day / day + 1 (day-ahead margins), with a granularity of 15 minutes.

 

3.11  "daily_procured_reserves" resource

This resource allows to obtain data relating to the results of daily calls for tenders for the contractualization of mFRR / RR and from 1st October 2021 for the contractualization of aFRR capacities (total power retained and marginal price per direction with 30min step).

 

3.12 " tso_need_for_procured_reserves" resource

This resource allows to obtain data relating to the needs published by RTE for the daily calls for tenders for the contractualization of mFRR / RR capacities and from 1st October 2021 for the contractualization of aFRR capacities.

 

 

 

 

 

The REST protocol is used to access the API described in this document.

As is the case for all of the APIs provided by RTE, accessing and using them is subject to the provisions of the General Terms and Conditions of Use [R1].

The API access authorization method is OAuth, whose uses are described in the FAQ.

 

 

 

 

5.1     procured_reserves resource 5.1.1   GET /procured_reserves 5.1.1.1 Call methods

The resource is exposed as follows:

 

Exposure

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/procured_reserves?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/procured_reserves

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the last day (see PROCRES-RG01).

 

This resource provides data from 12/17/2014. Data prior to that date are not available.

 

The suggestion is to call this resource once a day every day around 11:00pm to not exceed a period of 124 days per call.

 

5.1.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

PROCRES-RG01

PROCRES-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

PROCRES-RG01

PROCRES-RG02

1 Parameter dates can be expressed on any time zone

 

Call examples:

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/procured_reserves

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/procured_reserves?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.1.1.3 Outputs

 

NAME

CARD.

DESCRIPTION

procured_reserves

1..1

Table of {JSON} values structured as follows:

4..4

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PROCRES-RG03

PROCRES-RG04

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PROCRES-RG04

type

1..1

Reserve type

enum

One of the following values​:
FCR
AFRR
MFRR
RR

PROCRES-RG03

values

1..1

Values given at 30 min. time intervals. Table of {JSON} values structured as follows:

 

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

start_date

1..1

Start time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

End time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

updated_date

1..1

Date of the data’s update

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

 

direction

1..1

Balancing direction

enum

One of the following values​:
UP_DOWN
UPWARD
DOWNWARD

 

 

value

1..1

Reserve amount (in MW)

int

Integer

 

 

Price

1..1

Reserve price (in €/MW/30 min)

float

Decimal

                     

1 Return dates are in Paris time (UTC + 2 hours in summer, UTC + 1 hour in winter)

 

 

JSON return format:

GET  /open_api/balancing_capacity/v3/procured_reserves

HTTP/1.1 200 OK

{"procured_rerserves":[

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"FCR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":559, "price":9.16,"direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":558, "price":9.18,"direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

        ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"AFRR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "price":9.16,"direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "price":9.15,"direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

          ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"MFRR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "price":9.16,"direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "price":9.15,"direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

          ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"RR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "price":9.16,"direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "price":9.15,"direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

]}

 

 

 

5.1.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

Number

start_date

end_date

empty

empty

If no input parameter is set, the resource returns the procured balancing capacity for the current day.

PROCRES-RG01

known

known

If the start_date and end_date parameters are known, the resource all of the procured balancing capacity for that period.

PROCRES-RG02


Output control rules:

 

Number

Description

PROCRES-RG03

The output data is sorted by (start_date) from newest to oldest then by type in the following order:

·         Frequency Containment Reserve – FCR

·         Automatic Frequency Restoration Reserve – aFRR

·         Manual Frequency Restoration Reserve – MFRR

·         Replacement Reserves – RR

PROCRES-RG04

Upon resource output, the procured balancing capacity is returned to the calendar day segment.

 

5.1.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_PRORESERV_F01

§6.1.1

Functional

BALCAPOP_PRORESERV_F02

§6.1.1

Functional

BALCAPOP_PRORESERV_F03

§6.1.1

Functional

BALCAPOP_PRORESERV_F04

§6.1.1

Functional

BALCAPOP_PRORESERV_F05

§6.1.1

Functional

BALCAPOP_PRORESERV_F06

§6.1.1

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

5.2     accepted_offers resource 5.2.1   GET Accepted/offers 5.2.1.1 Call methods

 

The resource is exposed as follows:

 

Exposure

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/accepted_offers?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/accepted_offers

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the day (see ACCOFFERS-RG01).

 

This resource provides data from 12/16/2014. Data prior to that date are not available.

 

The suggestion is to call this resource every 30 min and to not exceed a period of 93 days per call.

 

5.2.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

ACCOFFERS-RG01

ACCOFFERS-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

ACCOFFERS-RG01

ACCOFFERS-RG02

1 Parameter dates can be expressed on any time zone

 

For example:

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/accepted_offers

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/accepted_offers?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.2.1.3 Outputs

The structure below is duplicated and repeated for each update date for the requested forecast:

 

NAME

CARD.

DESCRIPTION

accepted_offers

1..1

Table of {JSON} values structured as follows:

4..4

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

ACCOFFERS-RG03

ACCOFFERS-RG04

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

ACCOFFERS-RG04

type

1..1

Reserve type

enum

One of the following values​:
FCR
AFRR
MFRR
RR

ACCOFFERS-RG03

values

1..1

Values given at 30 min. time intervals. Table of {JSON} values structured as follows:

 

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

start_date

1..1

Start time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

End time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

updated_date

1..1

Date of the data’s update

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

 

direction

1..1

Balancing direction

enum

One of the following values​:
UP_DOWN
UPWARD
DOWNWARD

 

 

value

1..1

Volume of accepted offers (in MW)

int

Integer

                   

 1 Return dates are in Paris time (UTC + 2 hours in summer, UTC + 1 hour in winter)

 

JSON return format:

GET /balancing_capacity/v3/accepted_offers/

HTTP/1.1 200 OK

{"accepted_offers":[

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"FCR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":559, "direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":558, "direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

        ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"AFRR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

          ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"MFRR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

          ,

          {

          "start_date":"2015-01-01T00:00:00+01:00",

          "end_date":"2015-01-01T00:00:00+01:00",

          "type":"RR",

          "values":[{"start_date":"2015-01-01T00:00:00+01:00","end_date":"2015-01-01T00:30:00+01:00","value":650, "direction":"UP_DOWN","updated_date":"2016-01-04T00:00:00+01:00"},{"start_date":"2015-01-01T00:30:00+01:00", "end_date":"2015-01-01T01:00:00+01:00", "value":700, "direction":"UP_DOWN","updated_date":"2015-01-01T00:00:00+01:00"}, ... ]

          }

]}

 

 

5.2.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

 

Number

start_date

end_date

empty

empty

If no input parameter is set, the resource returns the offers accepted during the current day.

ACCOFFERS-RG01

known

known

If the start_date and end_date parameters are known, the operation returns all of the offers accepted for that period.

ACCOFFERS-RG02

 

Output control rules:

 

Number

Description

ACCOFFERS-RG03

The output data is sorted by (start_date) from newest to oldest then by type in the following order:

·         Frequency Containment Reserve – FCR

·         Secondary reserve – AFRR

·         Quick reserve – MFRR

·         Additional reserve – RR

ACCOFFERS-RG04

Upon resource output, accepted offers are returned to the calendar day segment.

 

5.2.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_ACCEPTEDOFFERS_F01

§6.1.2

Functional

BALCAPOP_ACCEPTEDOFFERS_F02

§6.1.2

Functional

BALCAPOP_ACCEPTEDOFFERS_F03

§6.1.2

Functional

BALCAPOP_ACCEPTEDOFFERS_F04

§6.1.2

Functional

BALCAPOP_ACCEPTEDOFFERS_F05

§6.1.2

Functional

BALCAPOP_ACCEPTEDOFFERS_F06

§6.1.2

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.3     peak_daily_margins resource 5.3.1   GET /peak_daily_margins 5.3.1.1 Call methods

 

The resource is exposed as follows:

 

Exposure

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/peak_daily_margins?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/peak_daily_margins

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the current day (see PEDAMA-RG01).

 

This resource provides data from 04/01/2003. Data prior to that date are not available.

 

The suggestion is to not exceed a period of 366 days per call.

 

5.3.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PEDAMA-RG01

PEDAMA-RG02

end_date

0..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PEDAMA-RG01

PEDAMA-RG02

1 Parameter dates can be expressed on any time zone

 

For example:

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/peak_daily_margins

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/peak_daily_margins?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.3.1.3 Outputs

The structure below is duplicated and repeated for each update date for the requested forecast:

 

NAME

CARD.

DESCRIPTION

peak_daily_margins

1..1

{JSON} table structured as follows:

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PEDAMA-RG03

PEDAMA-RG04

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

PEDAMA-RG03

PEDAMA-RG04

values

1..1

Values given at 30 min. time intervals. Table of {JSON} values structured as follows:

 

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

start_date

1..1

Start time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

End time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

updated_date

1..1

Date of the data’s update

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

morning_peak_period

1..1

{JSON} structure, structured as follows:

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

 

1..1

DURATION_BEFORE_MARGIN_PERIOD

1..1

Duration before morning time period

time

HH:MM

 

BEGIN_MARGIN_PERIOD

1..1

Morning margin time period (start)

time

HH:MM

 

END_MARGIN_PERIOD

1..1

Morning margin time period (end)

time

HH:MM

 

REQUIRED_MARGIN

1..1

Margin required (1% risk)

int

Integer (in MW)

 

MA_OFFERS

1..1

Increased available resources

excluding provisional imbalance

– Balancing Mechanism Offers

can be activated for the time period

int

Integer (in MW)

 

COMP_OFFERS

1..1

Increased available resources

excluding provisional imbalance

– Additional offers that can be activated for the time period

int

Integer (in MW)

 

RESCUE

1..1

Increased available resources

excluding provisional imbalance

– Emergency resources between TSOs

int

Integer (in MW)

 

 

IMBALANCE

1..1

Provisional imbalance at peak demand

int

Integer (in MW)

 

 

SIMULATED_MA_OFFERS

1..1

Increased available resources

with provisional imbalance at peak demand

 – Balancing Mechanism Offers

can be activated once the market has closed (at peak demand), factoring in the provisional imbalance

int

Integer (in MW)

 

 

SIMULATED_COMP_OFFERS

1..1

Increased available resources

with provisional imbalance at peak demand

– Additional offers that can be activated once the market has closed at peak demand

int

Integer (in MW)

 

 

SIMULATED_RESCUE

1..1

Increased available resources

with provisional imbalance at peak demand

– Emergency resources between TSOs

int

Integer (in MW)

 

 

SIMULATED_REQUIRED_MARGIN

1..1

Margin required at market closure

int

Integer (in MW)

 

 

AVAILABLE_VALUE

1..1

Available upward capacities without forecasted imbalance

int

Integer (in MW)

 

 

SIMUATED_AVAILABLE_VALUE

1..1

Available upward capacities including forecasted imbalance at the demand peak

int

Integer (in MW)

 

 

evening_peak_period

1..1

{JSON} structure, structured as follows:

 

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

 

 

1..1

DURATION_BEFORE_MARGIN_PERIOD

1..1

Duration before morning time period

time

HH:MM

 

 

BEGIN_MARGIN_PERIOD

1..1

Morning margin time period (start)

time

HH:MM

 

 

END_MARGIN_PERIOD

1..1

Morning margin time period (end)

time

HH:MM

 

 

REQUIRED_MARGIN

1..1

Margin required (1% risk)

int

Integer (in MW)

 

 

MA_OFFERS

1..1

Increased available resources

excluding provisional imbalance

– Balancing Mechanism Offers

can be activated for the time period

int

Integer (in MW)

 

 

COMP_OFFERS

1..1

Increased available resources

excluding provisional imbalance

– Additional offers that can be activated for the time period

int

Integer (in MW)

 

 

RESCUE

1..1

Increased available resources

excluding provisional imbalance

– Emergency resources between TSOs

int

Integer (in MW)

 

 

IMBALANCE

1..1

Provisional imbalance at peak demand

int

Integer (in MW)

 

 

SIMULATED_MA_OFFERS

1..1

Increased available resources

with provisional imbalance at peak demand

 – Balancing Mechanism Offers

can be activated once the market has closed (at peak demand), factoring in the provisional imbalance

int

Integer (in MW)

 

 

SIMULATED_COMP_OFFERS

1..1

Increased available resources

with provisional imbalance at peak demand

– Additional offers that can be activated once the market has closed at peak demand

int

Integer (in MW)

 

 

SIMULATED_RESCUE

1..1

Increased available resources

with provisional imbalance at peak demand

– Emergency resources between TSOs

int

Integer (in MW)

 

 

SIMULATED_REQUIRED_MARGIN

1..1

Margin required at market closure

int

Integer (in MW)

 

 

AVAILABLE_VALUE

1..1

Available upward capacities without forecasted imbalance

int

Integer (in MW)

 

 

SIMUATED_AVAILABLE_VALUE

1..1

Available upward capacities including forecasted imbalance at the demand peak

int

Integer (in MW)

 1 Return dates are in Paris time (UTC + 2 hours in the summer, UTC + 1 hour in the winter)

 

JSON return format:

GET /balancing_capacity/v3/peak_daily_margins/

HTTP/1.1 200 OK

{"peak_daily_margins": [

    {

      "start_date": "2018-12-14T00:00:00+01:00",

      "end_date": "2018-12-16T00:00:00+01:00",

      "values": [

        {

          "start_date": "2018-12-14T00:00:00+01:00",

          "end_date": "2018-12-15T00:00:00+01:00",

          "updated_date": "2018-12-14T19:04:00+01:00",

          "morning_peak_period": {

                        "DURATION_BEFORE_MARGIN_PERIOD": "6h01",

                        "BEGIN_MARGIN_PERIOD": "09h24",

                        "END_MARGIN_PERIOD": "11h43",

                        "REQUIRED_MARGIN": "2800",

                        "MA_OFFERS": "1800",

                        "COMP_OFFERS": "300",

                        "RESCUE ": "2600",

                        "IMBALANCE ": "-1000",

                        "SIMULATED_MA_OFFERS": "800",

                        "SIMULATED_COMP_OFFERS": "300",

                        "SIMULATED_RESCUE": "2600",

                        "SIMULATED_REQUIRED_MARGIN ": "2300"

                        "AVAILABLE_VALUE": "2300"

                        "SIMUATED_AVAILABLE_VALUE": "2300"

          },

          "evening_peak_period": {

                        "DURATION_BEFORE_MARGIN_PERIOD ": "20h05",

                        "BEGIN_MARGIN_PERIOD ": "17h03",

                        "END_MARGIN_PERIOD ": "19h04",

                        "REQUIRED_MARGIN": "1500",

                        "MA_OFFERS": "900",

                        "COMP_OFFERS": "200",

                        "RESCUE": "2500",

                        "IMBALANCE": "100",

                        "SIMULATED_MA_OFFERS": "800",

                        "SIMULATED_COMP_OFFERS": "300",

                        "SIMULATED_RESCUE": "2600",

                        "SIMULATED_REQUIRED_MARGIN ": "2300"

                        "AVAILABLE_VALUE": "2300"

                        "SIMUATED_AVAILABLE_VALUE": "2300"

                      }

                    }

            ]

          }

  ]

}

 

 

5.3.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

 

Number

start_date

end_date

empty

empty

If no input parameter is set, the resource returns the daily operating margin for the latest demand peaks.

PEDAMA-RG01

known

known

If the start_date and end_date parameters are known, the resource returns all daily operating margins for that period’s peak demand.

PEDAMA-RG02

 

Output control rules:

 

Number

Description

PEDAMA-RG03

The output data is sorted by start date (start_date) from newest to oldest.

PEDAMA-RG04

Upon resource output, the daily operating margin for demand peaks is returned to the calendar day segment.

 

5.3.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_PEAKDAILYMARG_F01

§6.1.3

Functional

BALCAPOP_PEAKDAILYMARG_F02

§6.1.3

Functional

BALCAPOP_PEAKDAILYMARG_F03

§6.1.3

Functional

BALCAPOP_PEAKDAILYMARG_F04

§6.1.3

Functional

BALCAPOP_PEAKDAILYMARG_F05

§6.1.3

Functional

BALCAPOP_PEAKDAILYMARG_F06

§6.1.3

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.4     insufficients_offers resource 5.4.1   GET /insufficients_offers 5.4.1.1 Call methods

 

The resource is exposed as follows:

 

Exposure

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/insufficients_offers?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/insufficients_offers

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the last day (see INSOFFERS-RG01).

 

This resource provides data from 07/17/2006. Data prior to that date are not available.

 

The suggestion is to call this resource once a day every day around 19:00 and to not exceed a period of 366 days per call.

 

5.4.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

INSOFFERS-RG01

INSOFFERS-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

INSOFFERS-RG01

INSOFFERS-RG02

1 Parameter dates can be expressed on any time zone

 

For example:

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/insufficients_offers

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/insufficients_offers?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1 200 OK

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.4.1.3 Outputs

The structure below is duplicated and repeated for each update date for the requested forecast:

 

NAME

CARD.

DESCRIPTION

insufficients_offers

1..1

{JSON} structure, structured as follows:

1..1

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

INSOFFERS-RG03

INSOFFERS-RG04

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

INSOFFERS-RG04

values

1..1

Table of {JSON} values structured as follows:

 

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

start_date

1..1

start day date

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

end day date

date

YYYY-MM-DDThh:mm:sszzzzzz1

updated_date

1..1

update date

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

 

type

1..1

lack of offer type

enum

DOWNGRADED
WARNING

 

 

nature

1..1

lack of offer nature

enum

BALANCE_SUPPLY_DEMAND
GRID

 

 

direction

1..1

lack of offer direction

enum

UPWARD
DOWNWARD

                   

 1 Return dates are in Paris time (UTC + 2 hours in summer, UTC + 1 hour in winter)

 

JSON return format:

GET /balancing_capacity/v3/insufficients_offers/

HTTP/1.1 200 OK

{"insufficients_offers":{

"start_date":"2015-01-28T00:00:00+01:00",

"end_date":"2015-01-29T00:00:00+01:00",

"values" :[  {"start_date":"2015-01-28T21:00:00+01:00","end_date":"2015-01-28T23:59:00+01:00", "updated_date":"2015-01-28T21:00:00+01:00","type":"DOWNGRADED","nature":"BALANCE_SUPPLY_DEMAND","direction":"UPWARD" }, ...    ]

}}

 

 

5.4.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

 

Number

start_date

end_date

empty

empty

If no input parameter is set, the resource returns the latest available messages on the lack of offers.

INSOFFERS-RG01

known

known

If the start_date and end_date parameters are known, the resource returns all the messages on the lack of offers for that period.

INSOFFERS-RG02

 

Output control rules:

 

Number

Description

INSOFFERS-RG03

The output data is sorted by (values/start_date) from newest to oldest.

INSOFFERS-RG04

Upon resource output, a message on the lack of offers is returned to the calendar day segment. The time interval between the start date and end date varies but cannot be more than 1 calendar day.

 

5.4.1.5 Error codes

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_INSUFOFFERS_F01

§6.1.4

Functional

BALCAPOP_INSUFOFFERS_F02

§6.1.4

Functional

BALCAPOP_INSUFOFFERS_F03

§6.1.4

Functional

BALCAPOP_INSUFOFFERS_F04

§6.1.4

Functional

BALCAPOP_INSUFOFFERS_F05

§6.1.4

Functional

BALCAPOP_INSUFOFFERS_F06

§6.1.4

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.5     imbalance resource 5.5.1   GET /imbalance 5.5.1.1 Call methods

The resource is exposed as follows:

 

Exposition

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/imbalance?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/imbalance

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the last day (see IMBALANCE-RG01).

 

This resource provides data from 27/12/2018. Data prior to that date are not available.

 

5.5.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

IMBALANCE-RG01

IMBALANCE-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

IMBALANCE-RG01

IMBALANCE-RG02

1 Parameter dates can be expressed on any time zone

 

For example:

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/imbalance

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/imbalance?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.5.1.3 Outputs

 

NAME

CARD.

DESCRIPTION

Imbalance

1..1

{JSON} table structured as follows:

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

IMBALANCE-RG03

IMBALANCE-RG04

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

IMBALANCE-RG04

values

1..1

Values given at 30 min. time intervals. Table of {JSON} values structured as follows:

 

0..n

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

start_date

1..1

Start time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

End time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

Value

1..1

Provisional imbalance volume (in MW)

int

Integer

 

updated_date

1..1

Date of the data’s update

date

YYYY-MM-DDThh:mm:sszzzzzz1

                     

1 Return dates are in Paris time (UTC + 2 hours in summer, UTC + 1 hour in winter)

 

JSON return format:

GET /balancing_capacity/v3/imbalance /

HTTP/1.1 200 OK

{

  "imbalance": [

    {

      "start_date": "2019-01-09T00:00:00+01:00",

      "end_date": "2019-01-10T00:00:00+01:00",

      "values": [

        {

          "start_date": "2019-01-09T00:00:00+01:00",

          "end_date": "2019-01-09T00:30:00+01:00",

          "value": 1390,

          "updated_date": "2019-01-08T23:34:03+01:00"

        },

        {

          "start_date": "2019-01-09T00:30:00+01:00",

          "end_date": "2019-01-09T01:00:00+01:00",

          "value": 1208,

          "updated_date": "2019-01-08T23:34:03+01:00"

        },

        {

          "start_date": "2019-01-09T20:30:00+01:00",

          "end_date": "2019-01-09T21:00:00+01:00",

          "value": 1788,

          "updated_date": "2019-01-09T15:24:03+01:00"

        }

      ]

    }

  ]

}

 

 

5.5.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

Number

start_date

end_date

empty

empty

If no input parameter is set, the resource automatically returns the short version of the provisional imbalance information from the start of the day, until the next five hours following the last publication.

Example: For a publication updated at 4:19 PM, the API will return the values from 5 PM to 9 PM in 30-minute increments (5 PM – 5:30 PM, 5:30 PM – 6 PM, …, 9:30 PM – 10 PM).

IMBALANCE-RG01

known

known

If the start_date and end_date parameters are entered, the resource returns all the imbalance values for this period.

IMBALANCE-RG02

 

Output control rules:

 

Number

Description

IMBALANCE-RG03

The output data is ordered by (start_date) from the oldest to the most recent.

IMBALANCE-RG04

As the resource’s output, the temporal reconciliation is returned to the calendar day segment.

 

5.5.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_IMBALANCE_F01

§6.1.5

Functional

BALCAPOP_IMBALANCE_F02

§6.1.5

Functional

BALCAPOP_IMBALANCE_F03

§6.1.5

Functional

BALCAPOP_IMBALANCE_F04

§6.1.5

Functional

BALCAPOP_IMBALANCE_F05

§6.1.5

Functional

BALCAPOP_IMBALANCE_F06

§6.1.5

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.6     individualoffers_energybids resource 5.6.1   GET /individualoffers_energybids 5.6.1.1 Call methods

The resource is exposed as follows:

 

Exposition

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/individualoffers_energybids?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/individualoffers_energybids

 (1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data for the current 30-minute time slot (see INDOFFENER-RG01).

 

5.6.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

INDOFFENER-RG01

INDOFFENER-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

INDOFFENER-RG01

INDOFFENER-RG02

1 Parameter dates can be expressed on any time zone. Indeed, the parameters start_date and end_date are expressed according to the ISO-8601 standard, where "zzzzzz" represents the time zone in the extended format (Z or +hh:mm or -hh:mm).

 

For example :

Without parameters

 

URL:

GET  /open_api/balancing_capacity/v3/individualoffers_energybids

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/individualoffers_energybids?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-08T20:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.6.1.3 Outputs

 

The return will be paginated in packs of 2000 lines.

 

NAME

CARD.

DESCRIPTION

offered_energybids

1..1

 

{JSON} table of values, structured as follows:

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

0..1

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz

end_date

1..1

End date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz

mesure

1..1

{JSON} structure, structured as follows:

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

start_date

1..1

Start date of a 15 min or 30 min time step included in the API request

date

YYYY-MM-DDThh:mm:sszzzzzz

end_date

1..1

End date of a 15 min or 30 min time step included in the API request

date

YYYY-MM-DDThh:mm:sszzzzzz

values

1..1

{JSON} structure, structured as follows:

0..n

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

Quantity

1..1

This field indicates the amount of energy submitted by the offer (in MW)

float

Decimal

PriceAmount

1..1

This field indicates the price charged by the balancing service provider for this energy (in €/MWh)

float

Decimal

offerType

1..1

This field indicates the type of offer that has been submitted.

enum

Standard, Specific

DMO

1..1

This field indicates the mobilisation lead time of the offer

int

Integer

ReserveType

1..1

This field indicates the type of reserve for which the offer has been submitted

enum

RR, mFRR

RowDirection

1..1

This field indicates if the offer has been submitted Upward or Downward

enum

Upward,
Downward 

Status

1..1

Only for standard offers, this field indicates the status of the offer. The value will be NA for all specific offers

enum

Available, Restricted, Blocked, NA

 

                   

 

JSON return format:

GET /balancing_capacity/v3/individualoffers_energybids/start_date=2019-05-01T22:00:00%2B02:00&end_date=2019-05-02T22:30:00%2B02:00

HTTP/1.1 200 OK

{

        "offered_energybids": {

               "start_date": "2019-05-01T22:00:00+02:00",

               "end_date": "2019-05-02T22:30:00+02:00",

               "mesure": [{

                       "start_date": "2019-05-01T22:00:00+02:00",

                       "end_date": "2019-05-01T22:15:00+02:00",

                       "values": [{

                                       "Quantity": 200,

                                       "PriceAmount": 35,

                                       "offerType": "Standard",

                                       "DMO": 30,

                                       "ReserveType": "RR",

                                       "RowDirection": "Upward",

                                       "Status": "Available"

                               },

                               {

                                       "Quantity": 100,

                                       "PriceAmount": 25,

                                       "offerType": "Standard",

                                       "DMO": 30,

                                       "ReserveType": "RR",

                                       "RowDirection": "Downward",

                                       "Status": "Restricted"

                               }

                       ]

               }, {

                       "start_date": "2019-05-01T22:15:00+02:00",

                       "end_date": "2019-05-01T22:30:00+02:00",

                       "offered_bids": [{

                                       "Quantity": 400,

                                       "PriceAmount": 55,

                                       "offerType": "Standard",

                                       "DMO": 30,

                                       "ReserveType": "RR",

                                       "RowDirection": "Upward",

                                       "Status": "Available"

                               },

                               {

                                       "Quantity": 100,

                                       "PriceAmount": 25,

                                       "offerType": "Standard",

                                       "DMO": 30,

                                       "ReserveType": "RR",

                                       "RowDirection": "Downward",

                                       "Status": "Available"

                               }

                       ]

               }]

        }

}

 

 

5.6.1.4 Control rule

Control rule based on input parameters:

 

Input parameters

Description

Number

start_date

end_date

If no input parameter is set, the resource automatically returns the data for the current 30-minute time slot

INDOFFENER-RG01

start_date

end_date

Parameters start_date et end_date cannot be used one without the other

INDOFFENER-RG02

 

5.6.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Details

Functional

BALCAPOP_INDOFFENER_F01

§6.1.6

Functional

BALCAPOP_INDOFFENER_F02

§6.1.6

Functional

BALCAPOP_INDOFFENER_F03

§6.1.6

Functional

BALCAPOP_INDOFFENER_F04

§6.1.6

Functional

BALCAPOP_INDOFFENER_F05

§6.1.6

Functional

BALCAPOP_INDOFFENER_F06

§6.1.6

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.7     aggregatedoffers_energybids resource 5.7.1   GET / aggregatedoffers_energybids 5.7.1.1 Call methods

The resource is exposed as follows:

 

Exposition

REST / JSON

Method

GET

URL resource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/aggregatedoffers_energybids?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/aggregatedoffers_energybids

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data for the current 30-minute time slot (see AGREGOFFENER-RG01).

 

Warning: in the attributes values_step15 and values_step30, the values at "0" mean that Rte has not received an offer for the hourly step, or that there has been an internal problem in the IS for the publication of these offers.

Warning: in the case of a successful return, the API necessarily returns at least one sub-attribute of the "values_step15" or "values_step30". A value of "0" can indicate the absence of offers for the type and direction of the returned offer, or the absence of information on the type and direction of the queried offer.

 

5.7.1.2 Inputs

 

NAME

CARD.

DESCRIPTION

TYPE

VALUES/FORMAT

RULES

start_date

0..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

AGREGOFFENER-RG01

AGREGOFFENER-RG02

end_date

0..1

End date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

AGREGOFFENER-RG01

AGREGOFFENER-RG02

1 Parameter dates can be expressed on any time zone. Indeed, the parameters start_date and end_date are expressed according to the ISO-8601 standard, where "zzzzzz" represents the time zone in the extended format (Z or +hh:mm or -hh:mm).

 

For example :

 

Without parameter

 

URL:

GET  /open_api/balancing_capacity/v3/aggregatedoffers_energybids

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

 

URL:

GET /open_api/balancing_capacity/v3/aggregatedoffers_energybids?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-08T20:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.7.1.3 Outputs

 

Aggregatedoffers_energybids

{JSON} list of 1 value, structured as follows:

[1..1]

NAME

CARD

TYPE

DESCRIPTION

VALUES/FORMAT

start_date

[1..1]

Date

Minimum of the start_date of the returned interval

 YYYY-MM-DDTHH:mm:sszzzzz

end_date

[1..1]

Date

Maximum of the end_date of the returned interval

 YYYY-MM-DDTHH:mm:sszzzzz

Offered_Volume

{JSON} table of values, structured as follows:

[0..n]

start_date

[1..1]

Date

This field corresponds to the start date of a 30 min time step

 YYYY-MM-DDTHH:mm:sszzzzz

end_date

[1..1]

Date

This field corresponds to the end date of a 30 min time step

YYYY-MM-DDTHH:mm:sszzzzz

values

 

UpwardOfferedVolumemFRR

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the mFRR reserve type, in the upward direction, for a given 30 min time step

decimal

UpwardOfferedVolumeRRSpecific

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Specific offer type, in the upward direction, for a given 30 min time step

decimal

DownwardOfferedVolumemFRR

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the mFRR reserve type, in the downward direction, for a given 30 min time step

decimal

DownwardOfferedVolumeRRSpecific

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Specific offer type, in the downward direction, for a given 30 min time step

decimal

 

Offered_RRstd_Volume

{JSON} table of values, structured as follows:

 

[0..n]

start_date

[1..1]

Date

This field corresponds to the start date of a 15 min time step

 YYYY-MM-DDTHH:mm:sszzzzz

end_date

[1..1]

Date

This field corresponds to the end date of a 15 min time step

 YYYY-MM-DDTHH:mm:sszzzzz

Values

[1..1]

UpwardOfferedVolumeRRStd

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Standard offer type, in the upward direction, for which the state is not Restricted, for a given 15 min time step

decimal

 

UpwardOfferedVolumeRRStdRestricted

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Standard offer type, in the upward direction, for which the state is  Restricted, for a given 15 min time step

decimal

 

DownwardOfferedVolumeRRStd

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Standard offer type, in the downward direction, for which the state is not Restricted, for a given 15 min time step

decimal

 

DownwardOfferedVolumeRRStdRestricted

[1..1]

float

The data indicates  the sum of the volumes of  the offers submitted with the RR reserve type, with the Standard offer type, in the downward direction, for which the state Restricted, for a given 15 min time step

decimal

 

JSON return format:

GET /balancing_capacity/v3/aggregatedoffers_energybids/start_date=2020-11-05T12:00:00%2B02:00&end_date=2020-11-05T13:00:00%2B02:00

HTTP/1.1 200 OK

{

    "aggregatedoffers_energybids": [

        {

            "start_date": "2020-11-05T12:00:00+01:00",

            "end_date": "2020-11-05T13:00:00+01:00",

            "Offered_RRstd_Volume": [

                {

                    "start_date": "2020-11-05T12:00:00+01:00",

                    "end_date": "2020-11-05T12:15:00+01:00",

                    "values":

                        {

                            "DownwardOfferedVolumeRRStdRestricted": 108.105,

                            "UpwardOfferedVolumeRRStd": 111.101,

                            "DownwardOfferedVolumeRRStd": 110.645,

                            "UpwardOfferedVolumeRRStdRestricted": 109.214

                        }

                },

                {

                    "start_date": "2020-11-05T12:15:00+01:00",

                    "end_date": "2020-11-05T12:30:00+01:00",

                    "values":

                        {

                            "DownwardOfferedVolumeRRStdRestricted": 108,

                            "UpwardOfferedVolumeRRStd": 111,

                            "DownwardOfferedVolumeRRStd": 110,

                            "UpwardOfferedVolumeRRStdRestricted": 109

                        }

                },

                {

                    "start_date": "2020-11-05T12:30:00+01:00",

                    "end_date": "2020-11-05T12:45:00+01:00",

                    "values":

                        {

                            "DownwardOfferedVolumeRRStdRestricted": 0,

                            "UpwardOfferedVolumeRRStd": 0,

                            "DownwardOfferedVolumeRRStd": 0,

                            "UpwardOfferedVolumeRRStdRestricted": 0

                        }

                },

                {

                    "start_date": "2020-11-05T12:45:00+01:00",

                    "end_date": "2020-11-05T13:00:00+01:00",

                    "values":

                        {

                            "DownwardOfferedVolumeRRStdRestricted": 108,

                            "UpwardOfferedVolumeRRStd": 111,

                            "DownwardOfferedVolumeRRStd": 110,

                            "UpwardOfferedVolumeRRStdRestricted": 109

                        }

                }

            ],

            "Offered_Volume": [

                {

                    "start_date": "2020-11-05T12:00:00+01:00",

                    "end_date": "2020-11-05T12:30:00+01:00",

                    "values":

                        {

                            "UpwardOfferedVolumemFRR": 104,

                            "UpwardOfferedVolumeRRSpecific": 106,

                            "DownwardOfferedVolumeRRSpecific": 107,

                            "DownwardOfferedVolumemFRR": 105

                        }

                },

                {

                    "start_date": "2020-11-05T12:30:00+01:00",

                    "end_date": "2020-11-05T13:00:00+01:00",

                    "values":

                        {

                            "UpwardOfferedVolumemFRR": 104,

                            "UpwardOfferedVolumeRRSpecific": 106,

                            "DownwardOfferedVolumeRRSpecific": 107,

                            "DownwardOfferedVolumemFRR": 105

                        }

                }

            ]

        }

    ]

}

 

 

5.7.1.4 Control rule

 

Control rule based on input parameters:

 

Input parameters

Description

Number

start_date

end_date

If no input parameter is set, the resource automatically returns the data for the current 30-minute time slot

AGREGOFFENER-RG01

start_date

end_date

Parameters start_date et end_date cannot be used one without the other

AGREGOFFENER-RG02

 

5.7.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error

Error code

Details

Functional

BALCAPOP_AGREGOFFENER_F01

§6.1.7

Functional

BALCAPOP_AGREGOFFENER_F02

§6.1.7

Functional

BALCAPOP_AGREGOFFENER_F03

§6.1.7

Functional

BALCAPOP_AGREGOFFENER_F04

§6.1.7

Functional

BALCAPOP_AGREGOFFENER_F05

§6.1.7

Functional

BALCAPOP_AGREGOFFENER_F06

§6.1.7

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.8     margins_data resource 5.8.1   GET /margins_data 5.8.1.1 Call methods

The resource is exposed as follows :

 

Exposition

REST / JSON

Méthode

GET

URL ressource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/margins_data?date=<valeur>&sens=<valeur>&type=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/margins_data

(1) ) The sandbox does not take input parameters into account

 

5.8.1.2 Inputs

 

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

REGLES

date

1..1

Start date of the search

date

YYYY-MM-DDThh:mm:sszzzzzz1

MARGINS-RG01

sens

0..1

Sens type

text

Up / Down / Up&Down

MARGINS-RG02

type

0..n

Margin type

text

All if empty or if the chosen parameter is not available

Available inputs :

forecastedImbalanceRs

availableMarginsComplemantaryDown

availableMarginsComplemantaryUp

availableMarginsNormalDown

availableMarginsNormalUp

availableMarginsReliefDown

availableMarginsReliefUp

requiredMarginsOperationnalDown

requiredMarginsOperationnalUp

MARGINS-RG02

1 Parameter dates can be expressed on any time zone. Indeed, the parameters start_date and end_date are expressed according to the ISO-8601 standard, where "zzzzzz" represents the time zone in the extended format (Z or +hh:mm or -hh:mm).

 

For example

 

With mandatory parameters

URL:

GET  /open_api/balancing_capacity/v3/margins_data? date=2020-11-15T00:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

With all parameters

URL:

GET  /open_api/balancing_capacity/v3/margins_data?date=2020-11-15T00:00:00%2B02:00&sens=Up&type=availableMarginsReliefUp

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.8.1.3 Outputs

 

NAME

CARD.

DESCRIPTION

 

 

1..1

{JSON} table structured as follows:

 

 

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

1..1

start_date

1..1

Start date of requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

computationTime

1..1

Computation time

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

projectionTime

1..1

Projection time

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

marginsData

1..1

Tableau de valeurs {JSON} structuré comme suit :

 

 

0..n

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

 

studiedTime

0..n

Studied Time

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

forecastedImbalanceRs

0..n

Forecasted imbalance

float

Decimal (in MW)

 

availableMarginsNormalDown

0..n

Decreased available resources

excluding forecasted imbalance

– Balancing Mechanism Offers

can be activated for the time period

 

float

Decimal (in MW)

 

availableMarginsComplementaryUp

0..n

Increased available resources

excluding forecasted imbalance

– Additional offers that can be activated for the time period

float

Decimal (in MW)

 

availableMarginsComplementaryDown

0..n

Decreased available resources

excluding forecasted imbalance

– Additional offers that can be activated for the time period

float

Decimal (in MW)

 

availableMarginsReliefUp

0..n

Increased available resources

excluding forecasted imbalance

– Emergency resources between TSOs

float

Decimal (in MW)

 

availableMarginsReliefDown

0..n

Decreased available resources

excluding forecasted imbalance

– Emergency resources between TSOs

float

Decimal (in MW)

 

requiredMarginsOperationnalUp

0..n

Increased Required Margin

float

Decimal (in MW)

 

requiredMarginsOperationnalDown

0..n

Decreased Required Margin

float

Decimal (in MW)

 

availableMarginsNormalUp

0..n

Increased available resources

excluding forecasted imbalance

– Balancing Mechanism Offers

can be activated for the time period

float

Decimal (in MW)

 

                   

1 Parameter dates can be expressed on any time zone. Indeed, the parameters start_date and end_date are expressed according to the ISO-8601 standard, where "zzzzzz" represents the time zone in the extended format (Z or +hh:mm or -hh:mm).

 

JSON return format (with a granularity of 15 minutes)

 (

GET /balancing_capacity/v3/margins_data/date=2020-06-18T12:36:13%2B02:00

HTTP/1.1 200 OK

    {

        "startDate": "2020-06-18T12:36:13.697",

        "computationTime": "2020-06-18T12:36:13.697",

        "projectionTime": "2020-06-18T12:36:13.697",

        "marginsData": [

            {

                "studiedTime":"2020-07-28T15:15:00.000+0000",

                "forecastedImbalanceRs":200.0,

                "availableMarginsNormalDown":-1351.0,

                "availableMarginsComplementaryUp":0.0,

                "availableMarginsComplementaryDown":0.0,

                "availableMarginsReliefUp":0.0,

                "availableMarginsReliefDown":0.0,

                "requiredMarginsOperationnalUp":1811.0,

                "requiredMarginsOperationnalDown":-1000.0,

                "availableMarginsNormalUp":1918.0

            },

            {

                "studiedTime":"2020-07-28T21:45:00.000+0000",

                "forecastedImbalanceRs":200.0,

                "availableMarginsNormalDown":-15374.0,

                "availableMarginsComplementaryUp":0.0,

                "availableMarginsComplementaryDown":0.0,

                "availableMarginsReliefUp":0.0,

                "availableMarginsReliefDown":0.0,

                "requiredMarginsOperationnalUp":3038.0,

                "requiredMarginsOperationnalDown":-2025.0,

                "availableMarginsNormalUp":6661.0

            }

        ]

    }

 

 

5.8.1.4 Control rule

Control rule based on input parameters:

 

Input parameter

Description

Number

date

Date is mandatory

MARGINS-RG01

sens / type

‘Sens’ and ‘Type’ have to be compliant

MARGINS-RG02

 

5.8.1.5 Error codes

 

The following table lists the error codes that can be returned during the call to the resource.

Details of these errors are in Chapter 6 Error details.

 

Error type

Error code

Detail

Functional

BALCAPOP_MARGINS_TR_F01

§6.1.8

Functional

BALCAPOP_MARGINS_TR_F02

§6.1.8

Functional

BALCAPOP_MARGINS_TR_F03

§6.1.8

Functional

BALCAPOP_MARGINS_TR_F04

§6.1.8

Technique

BALCAPOP_MARGINS_TR_F05

§6.1.8

Technical

401

§6.2

Technical

403

§6.2

Technical

404

§6.2

Technical

408

§6.2

Technical

413

§6.2

Technical

414

§6.2

Technical

429

§6.2

Technical

500

§6.2

Technical

503

§6.2

Technical

509

§6.2

 

5.9     Daily_procured_reserves resource 5.9.1   GET /daily_procured_reserves 5.9.1.1 Call methods

 

The resource is exposed as follows:

 

Exposition

REST / JSON

Méthode

GET

URL ressource

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/daily_procured_reserves?start_date=<valeur>&end_date=<valeur>

URL sandbox (1)

https://digital.iservices.rte-france.com/open_api/balancing_capacity/v3/sandbox/daily_procured_reserves

(1) The sandbox does not take input parameters into account

 

Call recommendations

 

In the case of nominal use, it is not necessary to complete period fields. The resource automatically returns the data received for the day (see DAIPROCRES-RG01).

 

This resource provides data from 01/06/2021. Data prior to that date are not available.

 

The suggestion is to call this resource everyday around 23h00 and to not exceed a period of 124 days per call.

 

5.9.1.2 Inputs

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

REGLES

start_date

0..1

Date de début de recherche

date

YYYY-MM-DDThh:mm:sszzzzzz1

DAIPROCRES-RG01

DAIPROCRES-RG02

end_date

0..1

Date de fin de recherche

date

YYYY-MM-DDThh:mm:sszzzzzz1

DAIPROCRES-RG01

DAIPROCRES-RG02

1 Parameter dates can be expressed on any time zone

For exemple:

Without parameters

URL:

GET  /open_api/balancing_capacity/v3/daily_procured_reserves

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

Without all parameters

URL:

GET /open_api/balancing_capacity/v3/daily_procured_reserves?start_date=2015-06-08T00:00:00%2B02:00&end_date=2015-06-11T00:00:00%2B02:00

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v3PW2UX6bF8z

Body:

 

5.9.1.3 Outputs

 

NOM

CARD.

DESCRIPTION

daily_procured_reserves

1..1

Table of {JSON} values structured as follows:

0..n

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

REGLES

start_date

1..1

Start date of the requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

DAIPROCRES-RG03

DAIPROCRES-RG04

end_date

1..1

End date of the requested data

date

YYYY-MM-DDThh:mm:sszzzzzz1

DAIPROCRES-RG04

type

1..1

Reserve type

enum

One of the following values:
FCR
AFRR
MFRR
RR

DAIPROCRES-RG03

 

values

1..1

Values ​​given by time interval of 30 min. Table of values ​​{JSON} structured as follows:

 

0..n

NOM

CARD.

DESCRIPTION

TYPE

VALEURS / FORMAT

start_date

1..1

Start time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

end_date

1..1

End time interval

date

YYYY-MM-DDThh:mm:sszzzzzz1

updated_date

1..1

Data update date

date

YYYY-MM-DDThh:mm:sszzzzzz1

 

direction

1..1

Balancing direction

enum

One of the following values:
UP_DOWN
UPWARD
DOWNWARD

 

value

1..1

Volume of accepted offers (in MW)

int

Integer (in MW)

 

price

1..1

Price of accepted offers (in €/MW/30min)

float

Decimal

 

 

temporality

1..1

Data temporality

enum

One of the following values: