Allgemeine API Nutzungshinweise

API Nutzerauthentifizierung

Ab dem 20.10.2022 wurde die Nutzerauthentifizierung auf die Methode OAuth2.0 Client Credential Grant umgestellt, welches den API Datenabruf generell vereinfacht und eine Machine-to-Machine Anbindung ermöglicht. Weiterführende Spezifikationen zu OAuth2.0 sind beispielsweise auf https://oauth.net/specs/ zu finden.

API Registrierung

Für den Zugriff auf die API Endpunkte muss in einem ersten Schritt der API Registrierungsprozess durchlaufen werden, um damit personalisierte Zugangsdaten für das Extranet und damit die Client Verwaltung zu erhalten. Wenn Sie sich registrieren möchten, klicken Sie bitte auf den Link https://extranet.netztransparenz.de/APIRegistrierung. Eine Schritt-für-Schritt Anleitung des Registrierungsprozesses finden Sie im Abschnitt API Dokumentation (siehe unten).

API Client Verwaltung

Für den Zugriff auf die API Endpunkte müssen Sie sich in einem zweiten Schritt mindestens einen Client anlegen. Dies ist über einen Login in das Extranet möglich. Hierzu klicken Sie bitte im Footer der Netransparenz.de auf „Extranet“, loggen sich ein und folgen den Anweisungen innerhalb der Client Verwaltung (OAuth Manager). Im Zuge dessen erhalten Sie je Client eine individuelle „Client_ID“ und ein individuelles „Client_Secret“. Bitte speichern Sie sich Ihr „Client_Secret“ separat ab, da es Ihnen nur 1x angezeigt wird. Eine Schritt-für-Schritt Anleitung der Client Verwaltung finden Sie im Abschnitt API Dokumentation (siehe unten).

API Datenabruf 

Als dritten Schritt benötigen Sie für den Zugriff auf die API Endpunkte mindestens die folgenden Informationen: 

Über die Swagger Umgebung besteht zudem für registrierte API Nutzer die Möglichkeit die verfügbaren API Endpunkte für einen angelegten Client zu testen (https://extranet.netztransparenz.de/DesktopModules/LotesDataManagementExtranet/Swagger/index.html?version=public). Dabei dient die Swagger Umgebung primär als zusätzliche Schnittstellendokumentation der API Endpunkte. Eine Schritt-für-Schritt Anleitung zur Nutzung der Swagger Umgebung finden Sie im Abschnitt API Dokumentation (siehe unten).

Beschreibung API Endpunkte
{data}
{product}
API-Endpunkt Verfügbarkeit
Hochrechnung Wind

hochrechnung
Solar

Aktuell verfügbar
Hochrechnung Solar
Wind
Online Hochrechnung Wind Onshore

OnlineHochrechnung
Windonshore
Online Hochrechnung Wind Offshore
Windoffshore
Online Hochrechnung Solar
Solar
Differenz Einspeiseprognose

vermarktung
DifferenzEinspeiseprognose
Inanspruchnahme Ausgleichsenergie
InanspruchnahmeAusgleichsenergie
Vermarktung untertägiger Strommengen
UntertaegigeStrommengen
Vermarktung EPEX
VermarktungEpex
Vermarktung EXAA
VermarktungExaa
Vermarktung Solar
VermarktungsSolar
Vermarktung Wind
VermarktungsWind
Vermarktung Sonstige
VermarktungsSonstige
Negative Preise 1h

NegativePreise
1
Negative Preise 4h
4
Negative Preise 6h
6
Jahresmarktwerte
Jahresmarktpraemie
n/e
Monatsmarktwerte
(API benötigt Angabe eines Abfragezeitraums)
marktpraemie
n/e
NRV Saldo Ampel
(API benötigt Angabe eines Abfragezeitraums)
TrafficLight
n/e
Redispatch
Redispatch
n/e
Kapazitätsreserve
Kapazitaetsreserve
n/e
Prognose Wind

prognose
Wind

bis 13.12.2022 verfügbar
Prognose Solar
Solar
NRV-Saldo betr.

nrvsaldo/NRVSaldo
Betrieblich

ab 29.11.2022 verfügbar
NRV-Saldo qual.
Qualitaetsgesichert
RZ-Saldo betr.

nrvsaldo/RZSaldo
Betrieblich
RZ-Saldo qual.
Qualitaetsgesichert
Aktivierte aFRR betr.

nrvsaldo/AktivierteSRL
Betrieblich
Aktivierte aFRR qual.
Qualitaetsgesichert
Aktivierte mFRR betr.

nrvsaldo/AktivierteMRL
Betrieblich
Aktivierte mFRR qual.
Qualitaetsgesichert
aFRR Optimierung betr.

nrvsaldo/SRLOptimierung
Betrieblich
aFRR Optimierung qual.
Qualitaetsgesichert
mFRR Optimierung betr.

nrvsaldo/MRLOptimierung
Betrieblich
mFRR Optimierung qual.
Qualitaetsgesichert
PRL (k * Delta f) betr.

nrvsaldo/PRL
Betrieblich
PRL (k * Delta f) qual.
Qualitaetsgesichert
Difference betr.

nrvsaldo/Difference
Betrieblich
Difference qual.
Qualitaetsgesichert
Zusatzmaßnahmen betr.

nrvsaldo/Zusatzmassnahmen
Betrieblich
Zusatzmaßnahmen qual.
Qualitaetsgesichert
Nothilfe fürs Ausland
nrvsaldo/Nothilfe
Qualitaetsgesichert
reBAP unterdeckt

nrvsaldo/reBAP

Qualitaetsgesichert
reBAP überdeckt
AEP Modul 1

nrvsaldo/AEPModule

Qualitaetsgesichert
AEP Modul 2
AEP Modul 3
Finanzielle Wirkung des AEP Moduls 2

nrvsaldo/FinanzielleWirkungAEPModule

Qualitaetsgesichert
Finanzielle Wirkung des AEP Moduls 3
AEP Schätzer
nrvsaldo/AepSchaetzer
Betrieblich
ab 14.03.2023 verfügbar
Mengengewichteter Day-Ahead Spotmarktpreis
Spotmarktpreise
n/e
ab 22.03.2023 verfügbar
Index Ausgleichsenergiepreis (ID-AEP)
IdAep
n/e
ab 15.08.2023 verfügbar

API Dokumentation 

Um Ihnen die Nutzung der API zur erleichtern, finden Sie hier weiterführende Dokumente: 

Link zur Dokumentation Web API

Link zur JSON Datei 

Link zu den FAQs 

Anleitung zur API Registrierung 

Anleitung zur Client Verwaltung

Anleitung zur Nutzung der Swagger Umgebung

Minimal Working Example (MWE) für Python

Minimal Working Example (MWE) für R

Minimal Working Example (MWE) für MATLAB

Hinweis in eigener Sache: Das Netztransparenz.de Team leistet keinen darüberhinausgehenden Support bei der Programmierung von Skripten.