Repository navigation
Add rest API to interact with external systems #16
Description
Implement a REST API interface to allow external systems, including users (through a web interface), to interact with Edge Mining application.
Features that could be implemented:
- Basic CRUD operations on the miner entity (Create, Read, Update and Delete)
- Basic CRUD operations on the home load entity and home load profile (Create, Read, Update and Delete)
- Basic CRUD operations on the optimization policy and automation rule (Create, Read, Update and Delete)
- Basic CRUD operations on the user settings (Create, Read, Update and Delete)
- Trigger an energy evaluation
- ...
I think it can be implemented with FastAPI.
We could use this discussion to think about what features could be included 🙂.
Activity
markoceri commentedon Apr 30, 2025
Implemented It using FastAPI.
API that still need to be implemented:
The default API port is
8001and can be changed from the .env file using the variableAPI_PORT.markoceri commentedon Aug 28, 2025
RestAPI interface available for the following domains:
Development in progress for the following domains:
Domains that needs Rest API development:
Note: All APIs can be explored interactively using the FastAPI Swagger documentation at:
http://localhost:8001/docsEnergy Optimization(policy) domain core#28Notification(notification) domain core#31Energy Optimization Unit(optimization_unit) domain core#32Mining Performance Analysis(performance) domain core#33markoceri commentedon Nov 23, 2025
The first version is close to release!
With the PR edge-mining/core#61 we can create Energy Optimization Units from CLI and RestAPI
Settings(settings) domain #8User Settings(user) domain #9Home Consumption Analytics(home_load) domain #10Energy Forecast(forecast) domain core#29Home Consumption Analytics(home_load) domain #10Energy Optimization(policy) domain core#28User Settings(user) domain #9Energy Optimization Unit(optimization_unit) domain core#32Notification(notification) domain core#31Settings(settings) domain #8Mining Performance Analysis(performance) domain core#33