Download OpenAPI specification:
HTTP API server for Südvolt customers to publish their nominations for the electricity balancing market
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response — if not defined otherwise — will be JSON in the following format:
{
"message": "page not found"
}
The API is versioned following semantic versioning rules, i.e. within each major version only backwards-compatible changes are made to the API.
The major version is part of the API URL for maximum visibility into which API version a client is calling so that clients operating on resources from the /api/v1/ set of resources will always observe deterministic behaviour.
Future Nomi releases may ship changes to the API in a backwards-incompatible way by incrementing the major version number and only shipping those changes in the /api/v2/ realm of resources.
Authentication is performed through the use of API tokens obtained through the /tokens resource. The only way to authenticate to the API server at the moment is by providing the API token as a bearer token in the HTTP Authorization header:
Authentication: Bearer API_TOKEN
By initiating a token request flow, a one-time code will be sent to the provided email address that can then be used to exchange the code for an API token.
foobar@example.org