OpenAPI Specifications

Target audience : dev

SmartGridready OpenAPI specifications provide standardized, machine readable descriptions of REST interfaces for selected use cases. They are based on established industry standards or defined SmartGridready models and facilitate consistent, interoperable integration across different systems and market participants.

The following sections describe the available OpenAPI specifications per use case.

Dynamic Tariffs

The VSE has published a handbook that establishes a common technical and conceptual foundation for dynamic network tariffs in distribution grids.

SmartGridready provides a corresponding OpenAPI specification that translates these requirements into a standardized REST interface definition. The specification defines how dynamic tariff data must be structured, time referenced and published in a machine readable format.

Note

The currently published specification is Version 1 (valid for 2026). The handbook is being revised by the VSE AG Dynamische Netznutzungstarife im Verteilnetz. The new version will be published in the course of 2026, coming into effect on 1 January 2027.

Access the specification

  • View the current OpenAPI specification for dynamic tariffs (Version 1, valid for 2026) in Swagger UI

  • Download the OpenAPI specification and JSON schema (Version 1, valid for 2026) on Github