EOS/docs/_generated/openapi.md

# Akkudoktor-EOS

**Version**: `v0.3.0.dev2607301181843779`

<!-- pyml disable line-length -->
**Description**: This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period.

## Currency Information

All monetary values in this API are expressed in the locally configured currency of the EOS installation. The system is designed to work with any currency (e.g., EUR, SEK, CHF, USD, GBP, etc.). Each installation uses a single, consistent currency throughout all endpoints and responses.

Values are given in whole currency units, not in hundredth subunits: a value of `0.0003` in an installation configured for Euro means 0.0003 EUR/Wh (i.e. 0.30 EUR/kWh), never cents. The same applies to all totals (e.g. `total_costs` of `1.5` = 1.50 EUR).

Field names containing cost, price, revenue, tariff, or similar monetary terms (e.g., `total_costs`, `electricity_price_per_wh`, `revenue_per_hour`) represent amounts in the configured currency, without explicit currency designation in the field name to maintain currency-neutrality.

## Deprecated Field Names

The genetic optimization API fields were renamed from German to English. For backward compatibility the old German field names (e.g. `gesamtlast`, `pv_prognose_wh`, `Gesamtbilanz_Euro`) are still accepted on input and are emitted in responses alongside the English names, marked as deprecated in the schema. They will be removed in a future release — new clients should use the English field names only.

<!-- pyml enable line-length -->

**Base URL**: `No base URL provided.`

**Endpoints**:

## POST /gesamtlast

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_gesamtlast_gesamtlast_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_gesamtlast_gesamtlast_post)
<!-- pyml enable line-length -->

Fastapi Gesamtlast

<!-- pyml disable line-length -->
```python
"""
Deprecated: Total Load Prediction with adjustment.

Endpoint to handle total load prediction adjusted by latest measured data.

Total load prediction starts at 00.00.00 today and is provided for 48 hours
in 1-hour intervals. If no prediction values are available the missing ones
at the start of the series are filled with the first available prediction value.

Note:
    Use '/v1/prediction/list?key=loadforecast_power_w' instead.
    Load energy meter readings to be added to EOS measurement by:
    '/v1/measurement/value' or
    '/v1/measurement/series' or
    '/v1/measurement/dataframe' or
    '/v1/measurement/data'
"""
```
<!-- pyml enable line-length -->

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/GesamtlastRequest"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /gesamtlast_simple

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_gesamtlast_simple_gesamtlast_simple_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_gesamtlast_simple_gesamtlast_simple_get)
<!-- pyml enable line-length -->

Fastapi Gesamtlast Simple

<!-- pyml disable line-length -->
```python
"""
Deprecated: Total Load Prediction.

Endpoint to handle total load prediction.

Total load prediction starts at 00.00.00 today and is provided for 48 hours
in 1-hour intervals. If no prediction values are available the missing ones
at the start of the series are filled with the first available prediction value.

Args:
    year_energy (float): Yearly energy consumption in Wh.

Note:
    Set LoadAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=loadforecast_power_w' instead.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `year_energy` (query, required): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## POST /optimize

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_optimize_optimize_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_optimize_optimize_post)
<!-- pyml enable line-length -->

Fastapi Optimize

<!-- pyml disable line-length -->
```python
"""
Deprecated: Optimize.

Endpoint to handle optimization.

Uses the `classic` GENETIC0 optimisation algorithm (__NO__ 15-minutes slots).

Note:
    Use automatic optimization instead.
    "v1/energy-management/optimization/solution/GENETIC0"
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `start_hour` (query, optional): Defaults to current hour of the day.

- `ngen` (query, optional): Number of indivuals to generate for genetic algorithm.

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/Genetic0OptimizationParameters"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /pvforecast

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_pvforecast_pvforecast_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_pvforecast_pvforecast_get)
<!-- pyml enable line-length -->

Fastapi Pvforecast

<!-- pyml disable line-length -->
```python
"""
Deprecated: PV Forecast Prediction.

Endpoint to handle PV forecast prediction.

PVForecast starts at 00.00.00 today and is provided for 48 hours
in 1-hour intervals. If no forecast values are available the missing ones
at the start of the series are filled with the first available forecast value.

Note:
    Set PVForecastAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=pvforecast_ac_power' and
    '/v1/prediction/list?key=pvforecastakkudoktor_temp_air' instead.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /strompreis

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_strompreis_strompreis_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_strompreis_strompreis_get)
<!-- pyml enable line-length -->

Fastapi Strompreis

<!-- pyml disable line-length -->
```python
"""
Deprecated: Electricity Market Price Prediction per Wh [amount/Wh].

Electricity prices start at 00.00.00 today and are provided for 48 hours
in 1-hour intervals. If no prices are available the missing ones at the
start of the series are filled with the first available price.

Note:
    Electricity price charges are added.

Note:
    Set ElecPriceAkkudoktor as provider, then update data with
    '/v1/prediction/update'
    and then request data with
    '/v1/prediction/list?key=elecprice_marketprice_wh' or
    '/v1/prediction/list?key=elecprice_marketprice_kwh' instead.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/admin/cache

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_cache_get_v1_admin_cache_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_cache_get_v1_admin_cache_get)
<!-- pyml enable line-length -->

Fastapi Admin Cache Get

<!-- pyml disable line-length -->
```python
"""
Current cache management data.

Returns:
    data (dict): The management data.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/cache/clear

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_cache_clear_post_v1_admin_cache_clear_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_cache_clear_post_v1_admin_cache_clear_post)
<!-- pyml enable line-length -->

Fastapi Admin Cache Clear Post

<!-- pyml disable line-length -->
```python
"""
Clear the cache.

Deletes all cache files.

Returns:
    data (dict): The management data after cleanup.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/cache/clear-expired

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_cache_clear_expired_post_v1_admin_cache_clear-expired_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_cache_clear_expired_post_v1_admin_cache_clear-expired_post)
<!-- pyml enable line-length -->

Fastapi Admin Cache Clear Expired Post

<!-- pyml disable line-length -->
```python
"""
Clear the cache from expired data.

Deletes expired cache files.

Returns:
    data (dict): The management data after cleanup.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/cache/load

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_cache_load_post_v1_admin_cache_load_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_cache_load_post_v1_admin_cache_load_post)
<!-- pyml enable line-length -->

Fastapi Admin Cache Load Post

<!-- pyml disable line-length -->
```python
"""
Load cache management data.

Returns:
    data (dict): The management data that was loaded.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/cache/save

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_cache_save_post_v1_admin_cache_save_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_cache_save_post_v1_admin_cache_save_post)
<!-- pyml enable line-length -->

Fastapi Admin Cache Save Post

<!-- pyml disable line-length -->
```python
"""
Save the current cache management data.

Returns:
    data (dict): The management data that was saved.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/database/save

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_database_save_post_v1_admin_database_save_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_database_save_post_v1_admin_database_save_post)
<!-- pyml enable line-length -->

Fastapi Admin Database Save Post

<!-- pyml disable line-length -->
```python
"""
Save in memory data to database.

Returns:
    data (dict): The database stats after saving the records.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/admin/database/stats

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_database_stats_get_v1_admin_database_stats_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_database_stats_get_v1_admin_database_stats_get)
<!-- pyml enable line-length -->

Fastapi Admin Database Stats Get

<!-- pyml disable line-length -->
```python
"""
Get statistics from database.

Returns:
    data (dict): The database statistics
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/database/vacuum

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_database_vacuum_post_v1_admin_database_vacuum_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_database_vacuum_post_v1_admin_database_vacuum_post)
<!-- pyml enable line-length -->

Fastapi Admin Database Vacuum Post

<!-- pyml disable line-length -->
```python
"""
Remove old records from database.

Returns:
    data (dict): The database stats after removal of old records.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/server/restart

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_server_restart_post_v1_admin_server_restart_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_server_restart_post_v1_admin_server_restart_post)
<!-- pyml enable line-length -->

Fastapi Admin Server Restart Post

<!-- pyml disable line-length -->
```python
"""
Restart the server.

Restart EOS properly by starting a new instance before exiting the old one.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/admin/server/shutdown

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_admin_server_shutdown_post_v1_admin_server_shutdown_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_admin_server_shutdown_post_v1_admin_server_shutdown_post)
<!-- pyml enable line-length -->

Fastapi Admin Server Shutdown Post

<!-- pyml disable line-length -->
```python
"""
Shutdown the server.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/config

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_get_v1_config_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_get_v1_config_get)
<!-- pyml enable line-length -->

Fastapi Config Get

<!-- pyml disable line-length -->
```python
"""
Get the current configuration.

Returns:
    configuration (ConfigEOS): The current configuration.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## PUT /v1/config

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_put_v1_config_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_put_v1_config_put)
<!-- pyml enable line-length -->

Fastapi Config Put

<!-- pyml disable line-length -->
```python
"""
Update the current config with the provided settings.

Note that for any setting value that is None or unset, the configuration will fall back to
values from other sources such as environment variables, the EOS configuration file, or default
values.

Args:
    settings (SettingsEOS): The settings to write into the current settings.

Returns:
    configuration (ConfigEOS): The current configuration after the write.
"""
```
<!-- pyml enable line-length -->

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/SettingsEOS"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/config/backup

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_backup_get_v1_config_backup_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_backup_get_v1_config_backup_get)
<!-- pyml enable line-length -->

Fastapi Config Backup Get

<!-- pyml disable line-length -->
```python
"""
Get the EOS configuration backup identifiers and backup metadata.

Returns:
    dict[str, dict[str, Any]]: Mapping of backup identifiers to metadata.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## PUT /v1/config/file

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_file_put_v1_config_file_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_file_put_v1_config_file_put)
<!-- pyml enable line-length -->

Fastapi Config File Put

<!-- pyml disable line-length -->
```python
"""
Save the current configuration to the EOS configuration file.

Returns:
    configuration (ConfigEOS): The current configuration that was saved.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## POST /v1/config/reset

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_reset_post_v1_config_reset_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_reset_post_v1_config_reset_post)
<!-- pyml enable line-length -->

Fastapi Config Reset Post

<!-- pyml disable line-length -->
```python
"""
Reset the configuration to the EOS configuration file.

Returns:
    configuration (ConfigEOS): The current configuration after update.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## PUT /v1/config/revert

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_revert_put_v1_config_revert_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_revert_put_v1_config_revert_put)
<!-- pyml enable line-length -->

Fastapi Config Revert Put

<!-- pyml disable line-length -->
```python
"""
Revert the configuration to a EOS configuration backup.

Returns:
    configuration (ConfigEOS): The current configuration after revert.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `backup_id` (query, required): EOS configuration backup ID.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/config/{path}

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_get_key_v1_config__path__get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_get_key_v1_config__path__get)
<!-- pyml enable line-length -->

Fastapi Config Get Key

<!-- pyml disable line-length -->
```python
"""
Get the value of a nested key or index in the config model.

Args:
    path (str): The nested path to the key (e.g., "general/latitude" or "optimize/nested_list/0").

Returns:
    value (Any): The value of the selected nested key.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `path` (path, required): The nested path to the configuration key (e.g., general/latitude).

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/config/{path}

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_config_put_key_v1_config__path__put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_config_put_key_v1_config__path__put)
<!-- pyml enable line-length -->

Fastapi Config Put Key

<!-- pyml disable line-length -->
```python
"""
Update a nested key or index in the config model.

Args:
    path (str): The nested path to the key (e.g., "general/latitude" or "optimize/nested_list/0").
    value (Any): The new value to assign to the key or index at path.

Returns:
    configuration (ConfigEOS): The current configuration after the update.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `path` (path, required): The nested path to the configuration key (e.g., general/latitude).

**Request Body**:

- `application/json`: {
  "anyOf": [
    {},
    {
      "type": "null"
    }
  ],
  "description": "The value to assign to the specified configuration path (can be None).",
  "title": "Value"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/energy-management/optimization/solution

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_energy_management_optimization_solution_get_v1_energy-management_optimization_solution_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_energy_management_optimization_solution_get_v1_energy-management_optimization_solution_get)
<!-- pyml enable line-length -->

Fastapi Energy Management Optimization Solution Get

<!-- pyml disable line-length -->
```python
"""
Get the latest solution of the optimization.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/energy-management/optimization/solution/{algorithm}

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_energy_management_optimization_solution_algorithm_get_v1_energy-management_optimization_solution__algorithm__get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_energy_management_optimization_solution_algorithm_get_v1_energy-management_optimization_solution__algorithm__get)
<!-- pyml enable line-length -->

Fastapi Energy Management Optimization Solution Algorithm Get

<!-- pyml disable line-length -->
```python
"""
Get the latest algorithm specific solution of the optimization.

Args:
    algorithm: Optimization algorithm
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `algorithm` (path, required): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/energy-management/plan

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_energy_management_plan_get_v1_energy-management_plan_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_energy_management_plan_get_v1_energy-management_plan_get)
<!-- pyml enable line-length -->

Fastapi Energy Management Plan Get

<!-- pyml disable line-length -->
```python
"""
Get the latest energy management plan.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/health

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_health_get_v1_health_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_health_get_v1_health_get)
<!-- pyml enable line-length -->

Fastapi Health Get

<!-- pyml disable line-length -->
```python
"""
Health check endpoint to verify that the EOS server is alive.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/logging/log

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_logging_get_log_v1_logging_log_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_logging_get_log_v1_logging_log_get)
<!-- pyml enable line-length -->

Fastapi Logging Get Log

<!-- pyml disable line-length -->
```python
"""
Get structured log entries from the EOS log file.

Filters and returns log entries based on the specified query parameters. The log
file is expected to contain newline-delimited JSON entries.

Args:
    limit (int): Maximum number of entries to return.
    level (Optional[str]): Filter logs by severity level (e.g., DEBUG, INFO).
    contains (Optional[str]): Return only logs that include this string in the message.
    regex (Optional[str]): Return logs that match this regular expression in the message.
    from_time (Optional[str]): ISO 8601 timestamp to filter logs not older than this.
    to_time (Optional[str]): ISO 8601 timestamp to filter logs not newer than this.
    tail (bool): If True, fetch the most recent log entries (like `tail`).

Returns:
    JSONResponse: A JSON list of log entries.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `limit` (query, optional): Maximum number of log entries to return.

- `level` (query, optional): Filter by log level (e.g., INFO, ERROR).

- `contains` (query, optional): Filter logs containing this substring.

- `regex` (query, optional): Filter logs by matching regex in message.

- `from_time` (query, optional): Start time (ISO format) for filtering logs.

- `to_time` (query, optional): End time (ISO format) for filtering logs.

- `tail` (query, optional): If True, returns the most recent lines (tail mode).

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/measurement/data

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_data_put_v1_measurement_data_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_data_put_v1_measurement_data_put)
<!-- pyml enable line-length -->

Fastapi Measurement Data Put

<!-- pyml disable line-length -->
```python
"""
Merge the measurement data given as datetime data into EOS measurements.
"""
```
<!-- pyml enable line-length -->

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/PydanticDateTimeData"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/measurement/dataframe

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_dataframe_put_v1_measurement_dataframe_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_dataframe_put_v1_measurement_dataframe_put)
<!-- pyml enable line-length -->

Fastapi Measurement Dataframe Put

<!-- pyml disable line-length -->
```python
"""
Merge the measurement data given as dataframe into EOS measurements.
"""
```
<!-- pyml enable line-length -->

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/PydanticDateTimeDataFrame"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/measurement/keys

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_keys_get_v1_measurement_keys_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_keys_get_v1_measurement_keys_get)
<!-- pyml enable line-length -->

Fastapi Measurement Keys Get

**Responses**:

- **200**: Successful Response

---

## DELETE /v1/measurement/range

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_range_delete_v1_measurement_range_delete), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_range_delete_v1_measurement_range_delete)
<!-- pyml enable line-length -->

Fastapi Measurement Range Delete

<!-- pyml disable line-length -->
```python
"""
Delete measurement values for a key within a datetime range.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Measurement key.

- `start_datetime` (query, optional): Start datetime.

- `end_datetime` (query, optional): End datetime.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/measurement/series

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_series_get_v1_measurement_series_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_series_get_v1_measurement_series_get)
<!-- pyml enable line-length -->

Fastapi Measurement Series Get

<!-- pyml disable line-length -->
```python
"""
Get the measurements of given key as series.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Measurement key.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/measurement/series

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_series_put_v1_measurement_series_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_series_put_v1_measurement_series_put)
<!-- pyml enable line-length -->

Fastapi Measurement Series Put

<!-- pyml disable line-length -->
```python
"""
Merge measurement given as series into given key.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Measurement key.

**Request Body**:

- `application/json`: {
  "$ref": "#/components/schemas/PydanticDateTimeSeries"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/measurement/value

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_measurement_value_put_v1_measurement_value_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_measurement_value_put_v1_measurement_value_put)
<!-- pyml enable line-length -->

Fastapi Measurement Value Put

<!-- pyml disable line-length -->
```python
"""
Merge the measurement of given key and value into EOS measurements at given datetime.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `datetime` (query, required): Datetime.

- `key` (query, required): Measurement key.

- `value` (query, required): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/prediction/dataframe

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_dataframe_get_v1_prediction_dataframe_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_dataframe_get_v1_prediction_dataframe_get)
<!-- pyml enable line-length -->

Fastapi Prediction Dataframe Get

<!-- pyml disable line-length -->
```python
"""
Get prediction for given keys within given date range as dataframe.

Args:
    key (list[str]): Prediction keys
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).
        Defaults to end datetime of latest prediction.
    interval (Optional[str]): Time duration for each interval.
        Defaults to 1 hour.
    fill_method (str): Method to handle missing values during resampling.

        - 'linear': Linearly interpolate missing values (for numeric data only).
        - 'time': Interpolate missing values (for numeric data only).
        - 'ffill': Forward fill missing values.
        - 'bfill': Backward fill missing values.
        - Defaults to 'linear' for numeric values, otherwise 'ffill'.

    resample_method (str):
        Method used to aggregate values within a resampling interval.

        - "first": Use the first value in each interval.
        - "mean": Compute the arithmetic mean of all samples in each interval.
        - "interval_mean": Compute the time-weighted mean assuming each
            value remains valid until the next timestamp (piecewise-constant
            signal).

    dropna: (bool, optional): Whether to drop NAN/ None values before processing.
        Defaults to True.
    boundary (Literal["strict", "context"]): resampling boundary
        "strict"  → only values inside [start, end)
        "context" → include one value before and after for proper resampling
    align_to_interval (bool): When True, snap the resample origin to the nearest
        UTC epoch-aligned boundary of ``interval`` before resampling.  This ensures
        that bucket timestamps always fall on wall-clock-round times regardless of
        when ``start_datetime`` falls:

        - 15-minute interval → buckets on :00, :15, :30, :45
        - 1-hour interval    → buckets on the hour

        When False (default), the origin is ``query_start`` (or ``"start_day"`` when
        no start is given), preserving the existing behaviour where buckets are
        aligned to the query window rather than the clock.

        Set to True when storing compacted records back to the database so that the
        resulting timestamps are predictable and human-readable.  Leave False for
        forecast or reporting queries where alignment to the exact query window is
        more important than clock-round boundaries.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `keys` (query, required): Prediction keys.

- `start_datetime` (query, optional): Starting datetime (inclusive).

- `end_datetime` (query, optional): Ending datetime (exclusive).

- `interval` (query, optional): Time duration for each interval. Defaults to 1 hour.

- `fill_method` (query, optional): Method to handle missing values during resampling.

- `resample_method` (query, optional): Method used to aggregate values within a resampling interval.

- `dropna` (query, optional): Drop NAN/ None values before processing.

- `boundary` (query, optional): Resampling boundary mode.

- `align_to_interval` (query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/prediction/import/{provider_id}

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_import_provider_v1_prediction_import__provider_id__put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_import_provider_v1_prediction_import__provider_id__put)
<!-- pyml enable line-length -->

Fastapi Prediction Import Provider

<!-- pyml disable line-length -->
```python
"""
Import prediction for given provider ID.

Args:
    provider_id: ID of provider to update.
    data: Prediction data.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `provider_id` (path, required): Provider ID.

- `force_enable` (query, optional): No description provided.

**Request Body**:

- `application/json`: {
  "anyOf": [
    {
      "$ref": "#/components/schemas/PydanticDateTimeDataFrame"
    },
    {
      "$ref": "#/components/schemas/PydanticDateTimeData"
    },
    {
      "type": "object",
      "additionalProperties": true
    },
    {
      "type": "null"
    }
  ],
  "title": "Data"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/prediction/keys

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_keys_get_v1_prediction_keys_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_keys_get_v1_prediction_keys_get)
<!-- pyml enable line-length -->

Fastapi Prediction Keys Get

<!-- pyml disable line-length -->
```python
"""
Get a list of available prediction keys.
"""
```
<!-- pyml enable line-length -->

**Responses**:

- **200**: Successful Response

---

## GET /v1/prediction/list

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_list_get_v1_prediction_list_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_list_get_v1_prediction_list_get)
<!-- pyml enable line-length -->

Fastapi Prediction List Get

<!-- pyml disable line-length -->
```python
"""
Get prediction for given key within given date range as value list.

Args:
    key (str): Prediction key
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).
        Defaults to end datetime of latest prediction.
    interval (Optional[str]): Time duration for each interval.
        Defaults to 1 hour.
    fill_method (str): Method to handle missing values during resampling.

        - 'linear': Linearly interpolate missing values (for numeric data only).
        - 'time': Interpolate missing values (for numeric data only).
        - 'ffill': Forward fill missing values.
        - 'bfill': Backward fill missing values.
        - Defaults to 'linear' for numeric values, otherwise 'ffill'.

    resample_method (str):
        Method used to aggregate values within a resampling interval.

        - "first": Use the first value in each interval.
        - "mean": Compute the arithmetic mean of all samples in each interval.
        - "interval_mean": Compute the time-weighted mean assuming each
            value remains valid until the next timestamp (piecewise-constant
            signal).

    dropna: (bool, optional): Whether to drop NAN/ None values before processing.
        Defaults to True.
    boundary (Literal["strict", "context"]): resampling boundary
        "strict"  → only values inside [start, end)
        "context" → include one value before and after for proper resampling
    align_to_interval (bool): When True, snap the resample origin to the nearest
        UTC epoch-aligned boundary of ``interval`` before resampling.  This ensures
        that bucket timestamps always fall on wall-clock-round times regardless of
        when ``start_datetime`` falls:

        - 15-minute interval → buckets on :00, :15, :30, :45
        - 1-hour interval    → buckets on the hour

        When False (default), the origin is ``query_start`` (or ``"start_day"`` when
        no start is given), preserving the existing behaviour where buckets are
        aligned to the query window rather than the clock.

        Set to True when storing compacted records back to the database so that the
        resulting timestamps are predictable and human-readable.  Leave False for
        forecast or reporting queries where alignment to the exact query window is
        more important than clock-round boundaries.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Prediction key.

- `start_datetime` (query, optional): Starting datetime (inclusive).

- `end_datetime` (query, optional): Ending datetime (exclusive).

- `interval` (query, optional): Time duration for each interval. Defaults to 1 hour.

- `fill_method` (query, optional): Method to handle missing values during resampling.

- `resample_method` (query, optional): Method used to aggregate values within a resampling interval.

- `dropna` (query, optional): Drop NAN/ None values before processing.

- `boundary` (query, optional): Resampling boundary mode.

- `align_to_interval` (query, optional): Snap resample origin to the nearest UTC epoch-aligned boundary of interval.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/prediction/providers

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_providers_get_v1_prediction_providers_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_providers_get_v1_prediction_providers_get)
<!-- pyml enable line-length -->

Fastapi Prediction Providers Get

<!-- pyml disable line-length -->
```python
"""
Get a list of available prediction providers.

Args:
    enabled (bool): Return enabled/disabled providers. If unset, return all providers.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `enabled` (query, optional): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## DELETE /v1/prediction/range

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_range_delete_v1_prediction_range_delete), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_range_delete_v1_prediction_range_delete)
<!-- pyml enable line-length -->

Fastapi Prediction Range Delete

<!-- pyml disable line-length -->
```python
"""
Delete prediction values for a key within a datetime range.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Prediction key.

- `start_datetime` (query, optional): Start datetime.

- `end_datetime` (query, optional): End datetime.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/prediction/series

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_series_get_v1_prediction_series_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_series_get_v1_prediction_series_get)
<!-- pyml enable line-length -->

Fastapi Prediction Series Get

<!-- pyml disable line-length -->
```python
"""
Get prediction for given key within given date range as series.

Args:
    key (str): Prediction key
    start_datetime (Optional[str]): Starting datetime (inclusive).
        Defaults to start datetime of latest prediction.
    end_datetime (Optional[str]: Ending datetime (exclusive).
        Defaults to end datetime of latest prediction.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `key` (query, required): Prediction key.

- `start_datetime` (query, optional): Starting datetime (inclusive).

- `end_datetime` (query, optional): Ending datetime (exclusive).

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## POST /v1/prediction/update

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_update_v1_prediction_update_post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_update_v1_prediction_update_post)
<!-- pyml enable line-length -->

Fastapi Prediction Update

<!-- pyml disable line-length -->
```python
"""
Update predictions for all providers.

Args:
    force_update: Update data even if it is already cached.
        Defaults to False.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `force_update` (query, optional): No description provided.

- `force_enable` (query, optional): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## POST /v1/prediction/update/{provider_id}

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_prediction_update_provider_v1_prediction_update__provider_id__post), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_prediction_update_provider_v1_prediction_update__provider_id__post)
<!-- pyml enable line-length -->

Fastapi Prediction Update Provider

<!-- pyml disable line-length -->
```python
"""
Update predictions for given provider ID.

Args:
    provider_id: ID of provider to update.
    force_update: Update data even if it is already cached.
        Defaults to False.
    force_enable: Update data even if provider is disabled.
        Defaults to False.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `provider_id` (path, required): No description provided.

- `force_update` (query, optional): No description provided.

- `force_enable` (query, optional): No description provided.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /v1/resource/status

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_devices_status_get_v1_resource_status_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_devices_status_get_v1_resource_status_get)
<!-- pyml enable line-length -->

Fastapi Devices Status Get

<!-- pyml disable line-length -->
```python
"""
Get the latest status of a resource/ device.

Return:
    latest_status: The latest status of a resource/ device.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `resource_id` (query, required): Resource ID.

- `actuator_id` (query, optional): Actuator ID.

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## PUT /v1/resource/status

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/fastapi_devices_status_put_v1_resource_status_put), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/fastapi_devices_status_put_v1_resource_status_put)
<!-- pyml enable line-length -->

Fastapi Devices Status Put

<!-- pyml disable line-length -->
```python
"""
Update the status of a resource/ device.

Return:
    latest_status: The latest status of a resource/ device.
"""
```
<!-- pyml enable line-length -->

**Parameters**:

- `resource_id` (query, required): Resource ID.

- `actuator_id` (query, optional): Actuator ID.

**Request Body**:

- `application/json`: {
  "anyOf": [
    {
      "$ref": "#/components/schemas/PowerMeasurement"
    },
    {
      "$ref": "#/components/schemas/EnergyMeasurement"
    },
    {
      "$ref": "#/components/schemas/PPBCPowerProfileStatus"
    },
    {
      "$ref": "#/components/schemas/OMBCStatus"
    },
    {
      "$ref": "#/components/schemas/FRBCActuatorStatus"
    },
    {
      "$ref": "#/components/schemas/FRBCEnergyStatus"
    },
    {
      "$ref": "#/components/schemas/FRBCStorageStatus"
    },
    {
      "$ref": "#/components/schemas/FRBCTimerStatus"
    },
    {
      "$ref": "#/components/schemas/DDBCActuatorStatus"
    }
  ],
  "description": "Resource Status.",
  "title": "Status"
}

**Responses**:

- **200**: Successful Response

- **422**: Validation Error

---

## GET /visualization_results.pdf

<!-- pyml disable line-length -->
**Links**: [local](http://localhost:8503/docs#/default/get_pdf_visualization_results_pdf_get), [eos](https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json#/default/get_pdf_visualization_results_pdf_get)
<!-- pyml enable line-length -->

Get Pdf

**Responses**:

- **200**: Successful Response

---

Auto generated from openapi.json.