# Introduction

The purpose of this documentation is to outline the Application Programming Interface (API) available via the batterX liveX Monitoring System.

The batterX liveX web-service allows access to the data stored in the local `SQLite3` database.

This documentation provides information about the technical features of the API, and describes each API with its parameters, formats and other details.

The batterX liveX API allows other software applications to access its monitoring system database for data analysis purposes, inverter management, displaying system data in other applications, etc.

## API Access

The Local API Endpoint can be accessed via **`HTTP`** protocol only.

The API Endpoint is: **`http://LIVEX_IP_ADDRESS/api.php`**\
\&#xNAN;*where `LIVEX_IP_ADDRESS` is the IP address of your batterX liveX.*

The request format and parameters are specified per each API.\
The response format is **`JSON`** (`application/json`).

## Usage Limitation

There is no limit on the number of API requests you can make, but because of limitations in the SQLite3 database architecture, we suggest you to not exceed **1 API request per second**.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://batterx.gitbook.io/batterx-livex-api/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.