Manual de usuario API.
Manual de usuario para la utilización de la API.
Manual de usuario de la API
Manual de usuario de la API.
ÍNDICE
1. INTRODUCCIÓN ...................................................................................................................... 3
2. OBTENCIÓN DEL TOKEN ......................................................................................................... 4
3. IMPLEMENTACIÓN TOKEN EN LAS DIFERENTES LLAMADAS.................................................. 5
4. REALIZACIÓN CONSULTAS API-PRIVADA ................................................................................ 6
4.1 OBTENER SUMINISTROS ................................................................................................. 6
4.2 OBTENER DETALLE DE UN CONTRATO ........................................................................... 7
4.3 OBTENER DATOS DE CONSUMOS................................................................................... 9
4.4 OBTENER DATOS DE POTENCIAS MÁXIMAS ................................................................ 11
4.5 OBTENER LISTADO DISTRIBUIDORAS CON SUMINISTRO ............................................. 13
5. REALIZACIÓN DE CONSULTAS API-PÚBLICA ......................................................................... 14
5.1 OBTENER CONSUMOS Y CONTRATOS .......................................................................... 14
5.2 OBTENER SUMATORIO DE CONSUMOS Y CONTRATOS ............................................... 17
5.3 OBTENER AUTOCONSUMO .......................................................................................... 19
5.4 OBTIENE SUMATORIO AUTOCONSUMO ...................................................................... 21
1. INTRODUCCIÓN
En el presente documento se explica mediante ejemplos de los distintos servicios de los que se
componen la API de Datadis, la cual, está creada con el propósito de acceder a la información
de los suministros, tanto propios como de terceros que le han autorizado, almacenada en las
bases de datos de las distintas distribuidoras eléctricas utilizando una API única.
Esta creada siguiendo las definiciones de API REST usando el estándar de respuesta HTTP
estándar en formato JSON.
Es una API de solo consulta por lo que se puede leer los datos, pero no añadir, modificar y
borrar información por lo que los únicos verbos HTTP utilizados son POST (para obtener el
token) y GET (para el resto de las llamadas).
Es importante tener en cuenta que las URL no están destinadas a ser utilizadas por
navegadores web sino por herramientas destinadas a realizar solicitudes HTTP o integrarlo
dentro de un software destinado para ello.
Para más información también puedes visualizar el apartado API en la página web
(https://datadis.es/private-api).
2. OBTENCIÓN DEL TOKEN
Llamada para obtener el token:
- TIPO LLAMADA HTTP: POST
- URL: https://datadis.es/nikola-auth/tokens/login
- PARÁMETROS EN EL BODY: Se deben insertar los parámetros username (documento de
identidad) y password.
A continuación, se expone un ejemplo de dicha llamada realizada tanto por POSTMAN (como
ejemplo de herramientas destinadas a realizar solicitudes HTTP) y mediante CURL (como
ejemplo de implementación en un software propio):
EJEMPLO CON POSTMAN
EJEMPLO CON CURL
curl -d "username=documentoUsuario&password=contraseña" -X POST
https://datadis.es/nikola-auth/tokens/login
Una vez lanzada la petición, mostrará el resultado de la consulta de la siguiente manera:
3. IMPLEMENTACIÓN TOKEN EN LAS DIFERENTES
LLAMADAS
Tenemos la posibilidad de consumir cinco servicios, para ello es necesario introducir el token
generado anteriormente.
Para realizar una consulta común, primero se debe introducir el token.
La forma de introducir dicho token es mediante la cabecera de la llamada utilizando el
encabezado “Authorization” seguido de la palabra “Bearer” y el token.
EJEMPLO DE IMPLEMENTACIÓN UTILIZANDO POSTMAN:
EJEMPLO DE IMPLEMENTACIÓN UTILIZANDO CURL:
curl -X GET "https://datadis.es/api-private/api/get-supplies" -H "accept:
application/json" -H "Authorization: Bearer eyJh………………”
4. REALIZACIÓN CONSULTAS API-PRIVADA
4.1 OBTENER SUMINISTROS
Obtiene la lista de suministros para el usuario que ha obtenido el token, para obtener la lista de
suministros a los que ha sido autorizado por un usuario debe indicar el NIF/NIE/CIF del usuario
propietario en el parámetro authorizedNif.
- TIPO LLAMADA HTTP: GET
- URL: https://datadis.es/api-private/api/get-supplies?authorizedNif=
- PARÁMETROS:
o authorizedNif: Si realiza la llamada siendo un usuario autorizado debe
especificar en este parámetro el documento de identidad del propietario del
CUPS. Si en cambio es usted el propietario, este parámetro no se debe añadir.
o distributorCode(Opcional): Se obtiene mediante OBTENER LISTADO
DISTRIBUIDORAS CON SUMINISTRO Si se pone este parámetro, se ira directo
contra la distribuidora.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
4.2 OBTENER DETALLE DE UN CONTRATO
Obtiene el detalle de contrato de un único CUPS indicado. Para obtener los detalles de contrato
para los que ha sido autorizado por un usuario debe indicar el NIF/NIE/CIF del usuario
propietario en el parámetro authorizedNif.
- TIPO LLAMADA HTTP: GET
- URL: http://datadis.es/api-private/api/get-contract-detail?authorizedNif=&cups=&distributorCode=
- PARÁMETROS:
o authorizedNif: Si realiza la llamada siendo un usuario autorizado debe
especificar en este parámetro el documento de identidad del propietario del
CUPS. Si en cambio es usted el propietario, este parámetro no se debe poner.
o cups: El CUPS del cual se quiere obtener los detalles del contrato
o distributorCode: Numero del 1 al 8 el cual obtendremos al ejecutar la petición
de obtener suministros
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-private/api/get-contract-detail?cups=ES00************&distributorCode=2
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
4.3 OBTENER DATOS DE CONSUMOS
Obtiene la lista de datos de consumo para un único CUPS indicado en las fechas especificadas.
Para obtener la lista de datos de consumo para los que ha sido autorizado por un usuario debe
indicar el NIF/NIE/CIF del usuario propietario en el parámetro authorizedNif.
- TIPO LLAMADA HTTP: GET
- URL: http://datadis.es/api-private/api/get-consumption-
data?authorizedNif=&cups=&distributorCode=&startDate=&endDate=&measurementType=&pointType=
- PARÁMETROS:
o authorizedNif: Si realiz la llamada siendo un usuario autorizado debe
especificar en este parámetro el documento de identidad del propietario del
CUPS. Si en cambio es usted el propietario, este parámetro no se debe poner.
o cups: El CUPS del cual se quiere obtener los detalles del contrato.
o distributorCode: Numero del 1 al 8 que se obtiene al ejecutar la petición de
obtención de suministros.
o startDate: Fecha de inicio por la cual se quiere empezar a buscar suministros.
Formato de fecha: AAAA/MM.
o endDate: Fecha final por la cual se quiere acabar de buscar suministros.
Formato de fecha: AAAA/MM.
o measurementType: Se introduce ‘0’ si se quiere consultar consumo horario o
‘1’ si se quiere consultar consumo cuarto horario.
o pointType: Numero del 1 al 5 el cual se obtiene al ejecutar la petición de
obtener suministros.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-private/api/get-consumption-
data?distributorCode=2&measurementType=0&cups=ES0***************&pointType=5&endDate=2023/02&
startDate=2023/02
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
* Importante, el campo “surplusEnergyKWh” se corresponde con la energía excedentaria o
vertida por autoconsumo en el caso de que hubiese.
Existe un control en el sistema que no permite repetir llamadas que hayan sido realizadas en
las últimas 24 horas. Pasado este tiempo, se habilitará la posibilidad de volver a realizar la
misma llamada. Este control va en función de un usuario y los parámetros "cups",
"distributorCode", "startDate", "endDate", "measurementType", "pointType" y
"authorizedNif".
No se permitirán repetir llamadas que generen errores provocados por parte del usuario tales
como parámetros incorrectos, formato erróneo, no disponer de autorización, etc.…
Por favor, tenga en cuenta de que, si necesitan los datos, éstos no podrán volver a ser
consultados hasta que no hayan pasado 24 horas. Les recomendamos que guarden los datos
obtenidos.
4.4 OBTENER DATOS DE POTENCIAS MÁXIMAS
Obtiene la lista de las potencias máximas de un único CUPS y las fechas indicadas. Para obtener
la lista de las máximas potencias para los que ha sido autorizado por un usuario debe indicar el
NIF/NIE/CIF del usuario propietario en el parámetro authorizedNif.
- TIPO LLAMADA HTTP: GET
- URL: http://datadis.es/api-private/api/get-max-power?authorizedNif=&cups=&distributorCode=&startDate=&endDate=
- PARÁMETROS:
o authorizedNif: Si realiza la llamada siendo un usuario autorizado debe
especificar en este parámetro el documento de identidad del propietario del
CUPS. Si en cambio es usted el propietario, este parámetro no se debe poner.
o cups: El CUPS del cual se quiere consultar los detalles del contrato.
o distributorCode: Numero del 1 al 8 el cual se obtiene al ejecutar la petición de
obtención de suministros.
o startDate: Fecha de inicio por la cual se quiere empezar a buscar suministros.
Formato de fecha: AAAA/MM.
o endDate: Fecha final por la cual se quiere acabar de buscar suministros.
Formato de fecha: AAAA/MM.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-private/api/get-max-
power?cups=ES00**********&distributorCode=8&startDate=2021/01&endDate=2022/01
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
Existe un control en el sistema que no permite repetir llamadas que hayan sido realizadas en
las últimas 24 horas. Pasado este tiempo, se habilitará la posibilidad de volver a realizar la
misma llamada. Este control va en función de un usuario y los parámetros "cups",
"distributorCode", "startDate" y "endDate".
No se permitirán repetir llamadas que generen errores provocados por parte del usuario tales
como parámetros incorrectos, formato erróneo, no disponer de autorización, etc.…
Por favor, tenga en cuenta de que, si necesitan los datos, éstos no podrán volver a ser
consultados hasta que no hayan pasado 24 horas. Les recomendamos que guarden sus datos.
4.5 OBTENER LISTADO DISTRIBUIDORAS CON SUMINISTRO
Obtiene un listado de los códigos de distribuidoras (utilizada en otras llamadas con el nombre
distributorCode) en la que el usuario o el autorizado tienen suministros.
- TIPO LLAMADA HTTP: GET
- URL: http://datadis.es/api-private/api/get-distributors-with-supplies?authorizedNif=
- PARÁMETROS:
o authorizedNif: Si realiza la llamada siendo un usuario autorizado debe
especificar en este parámetro el documento de identidad del propietario del
CUPS. Si en cambio es usted el propietario, este parámetro no se debe poner.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
5. REALIZACIÓN DE CONSULTAS API-PÚBLICA
5.1 OBTENER CONSUMOS Y CONTRATOS
Obtiene la lista de consumos y contratos por Comunidad Autónoma, sector y tensiones o
tarifas.
- TIPO LLAMADA HTTP: GET
- URL: https://datadis.es/api-public/api-search?page=&startDate=&endDate=&pageSize=&community=
- PARÁMETROS:
o startDate(obligatoria): Fecha de inicio entre los datos de búsqueda. Formato:
AAAA/MM/dd. Ejemplo = 2020/02/28
o endDate(obligatoria): Fecha de finalización entre los datos de búsqueda.
Formato: AAAA/MM/dd. Ejemplo = 2020/02/28.
o page(obligatoria): El número de página que desea ver. La primera página es 0.
o pageSize(obligatoria): Con este parámetro puede establecer el número de
resultados por página. El valor máximo es 2000.
o measurementPointType: Puede llamar por tipo de punto de medida
contratado. La API responde con una lista de resultados que coinciden con un
tipo de punto de medida seleccionado para el valor de consulta, seleccione el
nombre del tipo de punto de medida. Puede comprobar más de un tipo de
punto de medida. Ejemplo: 02
o community(obligatoria): Puede llamar por el nombre de la comunidad. Este
parámetro es obligatorio y el máximo que puede seleccionar es dos. La API
responde con una lista de resultados que coinciden con una palabra
seleccionada. Para el valor de la consulta, seleccione el nombre de la
comunidad. Puede marcar más de una comunidad. Ejemplo: 01.
o Distributor: Puede llamar por distribuidor. Usará el código de distribuidor XXXX
dígito. Ejemplo: del distribuidor ADURIZ DISTRIBUCIÓN, S.L. = 0172. Puede
combinar más de un distribuidor usando ', '. Ejemplo = 0172,0426.
o Fare: Puede llamar por tarifa contratada. La API responde con una lista de
resultados que coinciden con una tarifa seleccionada para el valor de la
consulta, seleccione el nombre de la tarifa. Puede consultar más de una tarifa.
Ejemplo: 31.
o provinceMunicipality: Puede llamar por provincia y municipio. Puede ver todos
los municipios aquí, utilizará 2 códigos: código de provincia = XX dígito y código
de municipio = XXX dígito. Ejemplo: desde el municipio Torrevieja = 03133, si
solo ingresas los 2 primeros dígitos buscaras por provincia. Ejemplo: Alicante =
03. Puedes combinar más de un municipio o provincia usando ','. Ejemplo:
03133,03132 o 03,04.
o postalCode: Puedes llamar por código postal. Ejemplo: 18817. Puedes
combinar más de un código postal usando ','. Ejemplo: 18817,18800.
o economicSector: Puede llamar por sector económico. La API responde con una
lista de resultados que coinciden con un sector económico seleccionado para el
valor de la consulta, seleccione el nombre del sector económico. Puede
consultar más de un sector económico. Ejemplo 1.
o tension: Puede llamar por tensión eléctrica. La API responde con una lista de
resultados que coinciden con una tensión eléctrica seleccionada para el valor
de consulta, seleccione la tensión eléctrica. Puede verificar más de una tensión
eléctrica. Ejemplo: E0.
o timeDiscrimination: Puede llamar por discriminación de tiempo. La API
responde con una lista de resultados que coinciden con una discriminación de
tiempo seleccionada para el valor de consulta, seleccione la discriminación de
tiempo. Puede verificar más de una discriminación de tiempo. Ejemplo: G0.
o sort: Con este parámetro puede ordenar sus resultados. Para el orden inverso,
debe agregar un símbolo '-' antes del campo. Ejemplo: _sort=dataDate. Puede
combinar más de una clasificación usando ',’. Puedes ordenar por: datoFecha,
comunidad, provincia, municipio, código postal, tarifa, medidaPuntoTipo,
tensión, Sectoreconómico, tiempoDiscriminación, distribuidor, sumaEnergía y
sumaContratos. Solo puedes ordenar por filtros utilizados anteriormente.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-public/api-
search?page=0&startDate=2022/04/16&endDate=2022/04/25&pageSize=200&community=01,02
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
5.2 OBTENER SUMATORIO DE CONSUMOS Y CONTRATOS
Obtiene el sumatorio de consumos y contratos.
- TIPO LLAMADA HTTP: GET
- URL: https://datadis.es/api-public/api-sum-search?page=&startDate=&endDate=&pageSize=&community=
- PARÁMETROS:
o startDate(obligatoria): Fecha de inicio entre los datos de búsqueda. Formato:
AAAA/MM/dd. Ejemplo = 2020/02/28
o endDate(obligatoria): Fecha de finalización entre los datos de búsqueda.
Formato: AAAA/MM/dd. Ejemplo = 2020/02/28.
o measurementPointType: Puede llamar por tipo de punto de medida
contratado. La API responde con una lista de resultados que coinciden con un
tipo de punto de medida seleccionado para el valor de consulta, seleccione el
nombre del tipo de punto de medida. Puede comprobar más de un tipo de
punto de medida. Ejemplo: 02
o community(obligatoria): Puede llamar por el nombre de la comunidad. Este
parámetro es obligatorio y el máximo que puede seleccionar es dos. La API
responde con una lista de resultados que coinciden con una palabra
seleccionada. Para el valor de la consulta, seleccione el nombre de la
comunidad. Puede marcar más de una comunidad. Ejemplo: 01.
o distributor: Puede llamar por distribuidor. Usará el código de distribuidor XXXX
dígito. Ejemplo: del distribuidor ADURIZ DISTRIBUCIÓN, S.L. = 0172. Puede
combinar más de un distribuidor usando ', '. Ejemplo = 0172,0426.
o fare: Puede llamar por tarifa contratada. La API responde con una lista de
resultados que coinciden con una tarifa seleccionada para el valor de la
consulta, seleccione el nombre de la tarifa. Puede consultar más de una tarifa.
Ejemplo: 31.
o provinceMunicipality: Puede llamar por provincia y municipio. Puede ver todos
los municipios aquí, utilizará 2 códigos: código de provincia = XX dígito y código
de municipio = XXX dígito. Ejemplo: desde el municipio Torrevieja = 03133, si
solo ingresas los 2 primeros dígitos buscaras por provincia. Ejemplo: Alicante =
03. Puedes combinar más de un municipio o provincia usando ','. Ejemplo:
03133,03132 o 03,04.
o postalCode: Puede llamar por código postal. Ejemplo: 18817. Puede combinar
más de un código postal usando ','. Ejemplo: 18817,18800.
o economicSector: Puede llamar por sector económico. La API responde con una
lista de resultados que coinciden con un sector económico seleccionado para el
valor de la consulta, seleccione el nombre del sector económico. Puede
consultar más de un sector económico. Ejemplo 1.
o tension: Puede llamar por tensión eléctrica. La API responde con una lista de
resultados que coinciden con una tensión eléctrica seleccionada para el valor
de consulta, seleccione la tensión eléctrica. Puede verificar más de una tensión
eléctrica. Ejemplo: E0.
o timeDiscrimination: Puede llamar por discriminación de tiempo. La API
responde con una lista de resultados que coinciden con una discriminación de
tiempo seleccionada para el valor de consulta, seleccione la discriminación de
tiempo. Puede verificar más de una discriminación de tiempo. Ejemplo: G0.
o sort: Con este parámetro puede ordenar sus resultados. Para el orden inverso,
debe agregar un símbolo '-' antes del campo. Ejemplo: _sort=dataDate. Puede
combinar más de una clasificación usando ',’. Puede ordenar por: datoFecha,
comunidad, provincia, municipio, código postal, tarifa, medidaPuntoTipo,
tensión, Sectoreconómico, tiempoDiscriminación, distribuidor, sumaEnergía y
sumaContratos. Solo puede ordenar por filtros utilizados anteriormente.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-public/api-sum-
search?page=0&startDate=2022/04/16&endDate=2022/04/25&pageSize=200&community=01,02
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
5.3 OBTENER AUTOCONSUMO
Obtiene la lista de autoconsumo por Comunidad Autónoma, sector y tensiones o tarifas.
- TIPO LLAMADA HTTP: GET
- URL: https://datadis.es/api-public/api-search-auto?page=&startDate=&endDate=&pageSize=&community=
- PARÁMETROS:
o startDate(obligatoria): Fecha de inicio entre los datos de búsqueda. Formato:
AAAA/MM/dd. Ejemplo = 2020/02/28
o endDate(obligatoria): Fecha de finalización entre los datos de búsqueda.
Formato: AAAA/MM/dd. Ejemplo = 2020/02/28.
o page(obligatoria): El número de página que desea ver. La primera página es 0.
o pageSize(obligatoria): Con este parámetro puedes establecer el número de
resultados por página. El valor máximo es 2000.
o community(obligatoria): Puede llamar por el nombre de la comunidad. Este
parámetro es obligatorio y el máximo que puede seleccionar es dos. La API
responde con una lista de resultados que coinciden con una palabra
seleccionada. Para el valor de la consulta, seleccione el nombre de la
comunidad. Puede marcar más de una comunidad. Ejemplo: 01.
o distributor: Puede llamar por distribuidor. Usará el código de distribuidor XXXX
dígito. Ejemplo: del distribuidor ADURIZ DISTRIBUCIÓN, S.L. = 0172. Puede
combinar más de un distribuidor usando ', '. Ejemplo = 0172,0426.
o selfConsumption: Puede llamar por autoconsumo contratado. La API responde
con una lista de resultados que coinciden con una tarifa seleccionada para el
valor de la consulta, seleccione el nombre de la tarifa. Puede consultar más de
una tarifa. Ejemplo: 31.
o province: Puede llamar por provincias Puede ver todas las provincias aquí usará
Código numérico de provincia = XX dígito Ejemplo: Desde provincia Alicante =
03, desde Almería = 04. Puede combinar más de una provincia usando, Ejemplo
= 04,18.
o sort: Con este parámetro puede ordenar sus resultados. Para el orden inverso,
debe agregar un símbolo '-' antes del campo. Ejemplo: _sort=dataDate. Puede
combinar más de una clasificación usando ',’. Puedes ordenar por: datoFecha,
comunidad, provincia, municipio, código postal, tarifa, medidaPuntoTipo,
tensión, Sectoreconómico, tiempoDiscriminación, distribuidor, sumaEnergía y
sumaContratos. Solo puedes ordenar por filtros utilizados anteriormente.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-public/api-search-
auto?page=0&startDate=2022/04/16&endDate=2022/04/25&pageSize=200&community=01,02
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON:
5.4 OBTIENE SUMATORIO AUTOCONSUMO
Obtiene el sumatorio del autoconsumo por Comunidad Autónoma, sector y tensiones o tarifas.
- TIPO LLAMADA HTTP: GET
- URL: https://datadis.es/api-public/api-sum-search-auto?page=&startDate=&endDate=&pageSize=&community=
- PARÁMETROS:
o startDate(obligatoria): Fecha de inicio entre los datos de búsqueda. Formato:
AAAA/MM/dd. Ejemplo = 2020/02/28
o endDate(obligatoria): Fecha de finalización entre los datos de búsqueda.
Formato: AAAA/MM/dd. Ejemplo = 2020/02/28.
o community(obligatoria): Puede llamar por el nombre de la comunidad. Este
parámetro es obligatorio y el máximo que puede seleccionar es dos. La API
responde con una lista de resultados que coinciden con una palabra
seleccionada. Para el valor de la consulta, seleccione el nombre de la
comunidad. Puede marcar más de una comunidad. Ejemplo: 01.
o distributor: Puede llamar por distribuidor. Usará el código de distribuidor XXXX
dígito. Ejemplo: del distribuidor ADURIZ DISTRIBUCIÓN, S.L. = 0172. Puede
combinar más de un distribuidor usando ', '. Ejemplo = 0172,0426.
o selfConsumption: Puede llamar por autoconsumo contratado. La API responde
con una lista de resultados que coinciden con una tarifa seleccionada para el
valor de la consulta, seleccione el nombre de la tarifa. Puede consultar más de
una tarifa. Ejemplo: 31.
o province: Puede llamar por provincias Puede ver todas las provincias aquí usará
Código numérico de provincia = XX dígito Ejemplo: Desde provincia Alicante =
03, desde Almería = 04. Puede combinar más de una provincia usando, Ejemplo
= 04,18.
• sort: Con este parámetro puede ordenar sus resultados. Para el orden inverso,
debe agregar un símbolo '-' antes del campo. Ejemplo: _sort=dataDate. Puede
combinar más de una clasificación usando ',’. Puedes ordenar por: datoFecha,
comunidad, provincia, municipio, código postal, tarifa, medidaPuntoTipo,
tensión, Sectoreconómico, tiempoDiscriminación, distribuidor, sumaEnergía y
sumaContratos. Solo puedes ordenar por filtros utilizados anteriormente.
IMPORTANTE INTRODUCIR TOKEN COMO SE CITA EN EL APARTADO 3. IMPLEMENTACIÓN
TOKEN EN LAS DIFERENTES LLAMADAS.
EJEMPLO DE LLAMADA:
https://datadis.es/api-public/api-sum-search-
auto?page=0&startDate=2022/04/16&endDate=2022/04/25&pageSize=200&community=01,02
Una vez lanzada la petición, se observa el resultado de la consulta en formato JSON: