# Einführung

Der Zweck dieser Dokumentation ist es, die Programmierschnittstelle (Application Programming Interface, API) zu beschreiben, die über das batterX liveX Monitoring System zur Verfügung steht.

Der batterX liveX Webservice ermöglicht den Zugriff auf die Daten, die in der lokalen `SQLite3`-Datenbank gespeichert sind.

Diese Dokumentation liefert Informationen zu den technischen Eigenschaften der API und beschreibt jede API mit ihren Parametern, Formaten und weiteren Details.

Die batterX liveX API ermöglicht es anderen Softwareanwendungen, auf die Datenbank des Monitoringsystems zuzugreifen, z. B. für Datenanalysen, Wechselrichterverwaltung, die Anzeige von Systemdaten in anderen Anwendungen usw.

## API-Zugriff

Der lokale API-Endpunkt ist ausschließlich über das **`HTTP`**-Protokoll erreichbar.

Der API-Endpunkt lautet: **`http://LIVEX_IP_ADDRESS/api.php`**\
\&#xNAN;*wobei `LIVEX_IP_ADDRESS` die IP-Adresse Ihres batterX liveX ist.*

Das Anfrageformat und die Parameter sind für jede API separat definiert.\
Das Antwortformat ist **`JSON`** (`application/json`).

## Nutzungseinschränkung

Es gibt keine feste Begrenzung für die Anzahl der API-Anfragen. Aufgrund von Einschränkungen der SQLite3-Datenbankarchitektur empfehlen wir jedoch, nicht mehr als **1 API-Anfrage pro Sekunde** auszuführen.