diff options
| author | Navan Chauhan <navanchauhan@gmail.com> | 2025-04-28 00:19:26 -0600 |
|---|---|---|
| committer | Navan Chauhan <navanchauhan@gmail.com> | 2025-04-28 00:19:26 -0600 |
| commit | 6ca0b8d9488bb16a118d00aadba1b6c7955f71b6 (patch) | |
| tree | 42aeca7849b9c159a949d984467cb8e6ef91f09f | |
| parent | 6ddbe77958db1f97ea64ba650a49fa47888d3f40 (diff) | |
update info
| -rw-r--r-- | README.md | 38 |
1 files changed, 5 insertions, 33 deletions
@@ -14,41 +14,13 @@ In production, rather than specifying the user ID as part of the bid, the backen Currently there is a cron job running every hour to check the bids in the database and then process them. In this process the market data is fetched in real-time from the gridstatus API. Ideally, the database is updated with the latest market data before processing the bids. That way the cron job can simply process the bids. +It is also possible to place a bid for < 11AM on the previous day at any time. But, this is to ensure you can run `python3 -m services.process_bids` to test with day-ahead data. + ### Timezones Everything is handled as UTC + Offset. Submit bid page shows the current time in the user's timezone as well as the timezone for the market. Everything else is displayed in UTC for now. -## 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 +## Requirements -* API Endpoints - * `GET /trader/pnl` +* Node: v22 +* Python: v3.11 |