Skip to content

Commit 1874221

Browse files
committed
Update README with paper trading docs and configuration table
1 parent 2831725 commit 1874221

File tree

1 file changed

+69
-3
lines changed

1 file changed

+69
-3
lines changed

README.md

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,92 @@ This bot is specifically designed to meet US regulatory requirements:
1919

2020
## Features
2121

22+
- **Paper Trading Mode** - Test strategies with $1000 virtual balance before going live
2223
- Auto-updates dependencies on launch
2324
- EMA crossover + RSI + volume spike entry logic
2425
- Dynamic TP levels based on ATR (0.5x, 1x, 1.5x, 2x)
2526
- Position persistence across restarts
2627
- Live Binance.US integration
2728

29+
## Paper Trading Mode
30+
31+
The bot defaults to paper trading mode so you can test without risking real money.
32+
33+
```
34+
==================================================
35+
🧻 PAPER TRADING MODE - NO REAL MONEY AT RISK
36+
Starting balance: $1000.00 USDT
37+
==================================================
38+
```
39+
40+
**Features:**
41+
- Starts with $1000 virtual USDT
42+
- Simulates buys/sells at real market prices
43+
- Tracks your paper P&L in `paper_trades.json`
44+
- Checks take-profit levels automatically
45+
- No API keys required (uses public price data)
46+
47+
**To switch to live trading:**
48+
```python
49+
PAPER_TRADING = False # Change this in scanner_pro_scalper.py
50+
```
51+
2852
## Setup
2953

3054
```bash
3155
pip install -r requirements.txt
56+
```
57+
58+
**For paper trading (no API keys needed):**
59+
```bash
60+
python scanner_pro_scalper.py
61+
```
62+
63+
**For live trading:**
64+
```bash
3265
export BINANCE_API_KEY='your_key'
3366
export BINANCE_API_SECRET='your_secret'
67+
# Edit scanner_pro_scalper.py and set PAPER_TRADING = False
3468
python scanner_pro_scalper.py
3569
```
3670

3771
## Configuration
3872

39-
- `REFRESH_INTERVAL`: Scan frequency (default: 10s)
40-
- `RISK_USDT`: Position size (default: 20 USDT)
73+
| Setting | Default | Description |
74+
|---------|---------|-------------|
75+
| `PAPER_TRADING` | `True` | Set to `False` for live trading |
76+
| `REFRESH_INTERVAL` | `10` | Scan frequency in seconds |
77+
| `RISK_USDT` | `20` | Position size per trade |
78+
| `paper_balance` | `1000.0` | Starting paper balance |
79+
80+
## How It Works
81+
82+
1. **Scans** all USDT pairs on Binance US
83+
2. **Entry Signal** triggers when:
84+
- EMA(5) crosses above EMA(20)
85+
- RSI > 50 (bullish momentum)
86+
- Volume spike (2x average)
87+
3. **Places buy** at market price
88+
4. **Sets 4 take-profit levels** based on ATR:
89+
- TP1: Entry + 0.5x ATR
90+
- TP2: Entry + 1.0x ATR
91+
- TP3: Entry + 1.5x ATR
92+
- TP4: Entry + 2.0x ATR
93+
5. **Sells portions** as each TP is hit
94+
95+
## Files
96+
97+
| File | Purpose |
98+
|------|---------|
99+
| `scanner_pro_scalper.py` | Main bot script |
100+
| `positions.json` | Active positions (persists across restarts) |
101+
| `paper_trades.json` | Paper trading history and balance |
102+
| `.env.example` | Example environment variables |
41103

42104
## ⚠️ Warning
43105

44-
Live trading bot - use at your own risk!
106+
This is a live trading bot - use at your own risk! Always:
107+
- Start with paper trading mode
108+
- Use read-only API keys when possible
109+
- Never invest more than you can afford to lose
110+
- Test thoroughly before going live

0 commit comments

Comments
 (0)