added markdown readme

This commit is contained in:
mhe
2025-10-26 16:41:49 +01:00
parent 054ad4d605
commit 225abca0ee

74
readme.md Normal file
View File

@@ -0,0 +1,74 @@
## backup
password ma+pi
```bash
sudo tar -czf stocktrader.tar.gz --exclude='/home/mhe/projects/stocktrader/frontend/node_modules' --exclude='/home/mhe/projects/stocktrader/database' --exclude='/home/mhe/projects/stocktrader/frontend/.angular/cache' /home/mhe/projects/stocktrader
```
Service API:
test mit http://localhost:8000/docs
### Health Zustand abfragen
GET http://localhost:8000/api/health
### Authorisierung
GET /api/auth/login
http://localhost:8000/api/auth/login
### Liste aller Aktien
GET /api/stocks/list
http://localhost:8000/api/stocks/list
### Details zu einem Symbol (StockInfo)
GET /api/stocks/information?ticker=SYMBOL
http://localhost:8000/api/stocks/information?ticker=AAPL
### History (Kursverlauf einer Aktie)
GET /api/stocks/{SYMBOL}/history?period=PERIOD
http://localhost:8000/api/stocks/AAPL/history
http://localhost:8000/api/stocks/AAPL/history?period=24h
### Historien mehrerer Symbole (Batch)
GET /api/stocks/histories?symbols=SYM1&symbols=SYM2&period=PERIOD
http://localhost:8000/api/stocks/histories?symbols=AAPL&symbols=TSLA&period=24h
### Heatmap
GET /api/stocks/heatmap?type=TYPE&period=PERIOD
http://localhost:8000/api/stocks/heatmap?type=S&P&period=24h
### Performance
GET /api/stocks/performance?interval=PERIOD
GET /api/stocks/performance?start=STARTDATE&end=ENDDATE
GET /api/stocks/performance?actual_balance
GET /api/stocks/performance?total_return_all
http://localhost:8000/api/performance?interval=1month
http://localhost:8000/api/performance?start=2023-01-01&end=2023-12-31
http://localhost:8000/api/performance?actual_balance
http://localhost:8000/api/performance?total_return_all
### failure Analysis
GET /api/failure
http://localhost:8000/api/failure
### Dashboard
GET /api/failudashboard
http://localhost:8000/api/dashboard
## Post:
### Update einer Aktie
POST http://localhost:8000/api/stocks/update
Service WS:
http://localhost:8000/ws/ticks
http://localhost:8000/ws/stocks