The REData API provides a simple REST service to allow third parties to access the backend data used in the REData application. By using this API, you will be able to retrieve data from the REData widgets and use them for your own purposes. The use of this service is pretty simple. Only GET requests are allowed since the purpose of this API is to provide data related to the REData app. Each widget is set up by a series of indicators which provide data related to a particular category. The detailed format of the URI can be found below.

Returns a specific widget filtered by a date range, time aggregation and geo ids.

Request overview

GET /{lang}/datos/{category}/{widget}?[query]

Parameters

lang

category

widget

query

Headers

Accept: application/json;
Content-Type: application/json
Host: apidatos.ree.es

URI definition

Query definition

Query parameters are described below:

start_date

YYYY-MM-DDTHH:MM

end_date

YYYY-MM-DDTHH:MM

time_trunc

geo_trunc

electric_system

geo_limit

geo_ids

The optional parameters are not mandatory, however, if you wish to make a request for a particular region you must send all the above parameters in the request. If no geo params are sent, the default region will be either national or peninsular (it will depend on the requested widget). The table below defines the geo_ids of each electrical system/autonomous community:

Example request

Below are listed a few example requests combining several query parameters:

Requesting the daily balance widget for January (default geo_limit; Spanish):

https://apidatos.ree.es/es/datos/balance/balance-electrico?start_date=2019-01-01T00:00&end_date=2019-01-31T23:59&time_trunc=day

Requesting the monthly general IRE widget for the year 2018 (peninsular geo_limit; English):

https://apidatos.ree.es/en/datos/demanda/ire-general?start_date=2018-01-01T00:00&end_date=2018-12-31T23:59&time_trunc=month&geo_trunc=electric_system&geo_limit=peninsular&geo_ids=8741

Requesting the yearly generation structure widget between 2014 and 2018 (ccaa geo_limit; Castilla la Mancha; Spanish):

https://apidatos.ree.es/es/datos/generacion/estructura-generacion?start_date=2014-01-01T00:00&end_date=2018-12-31T23:59&time_trunc=year&geo_trunc=electric_system&geo_limit=ccaa&geo_ids=7

The responses generated by the REData API are always served in JSON format following the JSONAPI standarts. The API will process the received request and will return either the requested widget or an error response message. In case the request was successfully processed a 200 status code will be returned, otherwise, an error status code will be present in the response.

Successful responses

The successful responses have structure similar to the following one:

	   {
		 "data": {
		   "type": "WIDGET TYPE",
		   "id": "WIDGET_ID",
		   "attributes": {
			 "title": "WIDGET NAME",
			 "last-update": "2019-02-01T08:26:34.000+01:00",
			 "description": "WIDGET DESCRIPTION",
		   },
		   "meta": {
			 "cache-control": {
			   "cache": "HIT",
			   "expireAt": "2019-03-01T17:18:22"
			 }
		   }
		 },
		 "included": [
		   {
			 "type": "INDICATOR_1 TYPE",
			 "id": "INDICADOR_1_ID",
			 "groupId": null,
			 "attributes": {
			   "title": "INDICADOR_1 NAME",
			   "description": "INDICADOR_1 DESCRIPTION",
			   "color": "#2fa688",
			   "type": "INDICADOR_1 TYPE",
			   "magnitude": "INDICADOR_1 MAGNITUDE",
			   "composite": false, "last-update": "2019-02-19T08:26:34.000+01:00",
			   "values": [
				 {
				   "value": 12345,
				   "percentage": "VALUE BETWEEN 0 AND 1",
				   "datetime": "2019-02-04T20:44:00.000+01:00"
				 }
			   ]
			 },
		   {
			 "type": "INDICATOR_2 TYPE",
			 "id": "INDICADOR_1_ID",
			 "groupId": null,
			 "attributes": {
			   …
			 }
			}
		   ]
		 }
	   }
	

This example is meant to be orientative, mind that some of the attributes presented above may vary from widget to widget.

Error responses

In some cases, if the service is temporary unavailable or an incorrect request was sent, the API may return an error response. The error responses have the following structure:

   {
     "errors":[
             {
                    "code":XXX,
                    "status":"YYY",
                    "title":"ERROR TITLE",
                    "detail":"DETAILED ERROR"
             }
     ]
   }

In case an error response was sent, the status code of the response will vary depending on the error. More specific details can be found under the 'detail' property of the JSON object returned.