diff options
| author | Navan Chauhan <navanchauhan@gmail.com> | 2025-04-27 12:03:31 -0600 |
|---|---|---|
| committer | Navan Chauhan <navanchauhan@gmail.com> | 2025-04-27 12:03:31 -0600 |
| commit | 9a2d251680ace44924994b89cf9777efcd020cb1 (patch) | |
| tree | 29a663f6b921d8aeb868ea59a596eb98c8e74626 | |
| parent | 9b54bad317b69d17134ddc27a5570984fba15826 (diff) | |
initial thoughts
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6484c9d --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Virtual Energy Trading App + +## Project Structure + +``` +/client # React Frontend +/server # Python Backend +/tests # Tests if I ever get to them +``` + +## Backend + +### FastAPI Server + +#### Market Data Service + +* Fetch from GridStatus API + * Real-time prices + * Day-ahead market prices + * Load/demand data +* API Endpoints + * `GET /market/day-ahead` + * `GET /market/real-time` + * `GET /market/load` + +#### Bid Management + +* API Endpoints + * `POST /bids` + * `GET /bids` + * `DELETE /bids/{bid_id}` + +#### Profit et Loss Simulation + +* API Endpoints + * `GET /trader/pnl` + + + |