General API usage information

API user authentication

From 20.10.2022, user authentication was switched to the OAuth2.0 Client Credential Grant method, which generally simplifies API data retrieval and enables a machine-to-machine connection. Further specifications on OAuth2.0 can be found at https://oauth.net/specs/, for example.

API registration

To access the API endpoints, the first step is to go through the API registration process in order to receive personalized access data for the extranet and thus the client administration. If you would like to register, please click on the link https://extranet.netztransparenz.de/APIRegistrierung. A step-by-step guide to the registration process can be found in the API documentation section (see below).

API Client Management

To access the API endpoints, you must create at least one client in a second step. This is possible via a login to the extranet. To do this, please click on "Extranet" in the footer of Netransparenz.de, log in and follow the instructions within the client administration (OAuth Manager). In the course of this you will receive an individual "Client_ID" and an individual "Client_Secret" for each client. Please save your "Client_Secret" separately, as it will only be displayed once. You can find step-by-step instructions for client management in the API documentation section (see below).

API data retrieval

As a third step, you need at least the following information to access the API endpoints:

• Individual Client_ID (according to client administration)

• Individual Client_Secret (according to client administration)

• Grant Type: 'client_credentials'

• Access Token URL: https://identity.netztransparenz.de/users/connect/token 

• URL API endpoints (example): https://ds.netztransparenz.de/api/v1/data/{data}/{product}/{dateFrom}/{dateTo}

Registered API users can also use the Swagger environment to test the available API endpoints for a created client (https://extranet.netztransparenz.de/DesktopModules/LotesDataManagementExtranet/Swagger/index.html?version=public). The Swagger environment primarily serves as additional interface documentation for the API endpoints. A step-by-step guide to using the Swagger environment can be found in the API documentation section (see below).

API documentation

To make it easier for you to use the API, you will find further documents here:

Link to the Web API documentation

Link to the JSON file

Link to the FAQs

Instructions for API registration

Instructions for client administration

Instructions for using the Swagger environment

Minimal Working Example (MWE) for Python

Minimal Working Example (MWE) for R

Minimal Working Example (MWE) for MATLAB

Note on our own behalf: The Netztransparenz.de team does not provide any additional support for the programming of scripts.