System Requirements
- Python: Version 3.7 or higher
- Operating System: Linux, macOS, or Windows
- Internet: Stable connection for API calls
- Disk Space: ~10 MB for code and dependencies
Installation Steps
Get the Source Code
Clone the repository or download the source:Alternatively, download the ZIP file and extract it:
Install Python Dependencies
Install required packages from Or install packages individually:
requirements.txt:If you get a “permission denied” error, try using
pip install --user instead.Create Configuration File
Copy the example environment file:The
.env file controls all bot behavior. See the Configuration section below for details.Configuration
Edit the.env file to customize bot behavior. Here are all available options:
Basic Settings
.env
Strategy Parameters
.env
What is “R”? R is your risk unit, calculated as
bankroll × CONSENSUS_RISK_PCT. For a 5. A daily loss cap of 3R means the bot stops trading CONSENSUS strategies after losing $15 in a day.Output Files
.env
API Credentials (Optional)
Not required for paper trading. The bot only uses public market data APIs. These fields are reserved for future real trading functionality.
.env
Running the Bot
Basic Usage
Start the bot with default settings:Running in Background
To run the bot in the background and log output:Stopping the Bot
Gracefully stop the bot:Troubleshooting
”No module named ‘requests’” Error
The dependencies aren’t installed. Run:“Permission denied” Error
Try installing packages in user mode:“No open KXBTC15M market found”
This can happen during market hours gaps or if using production API outside trading hours. The bot will keep polling until a market opens.BTC Price Errors
If you see[BTC price error: ...], the Coinbase API is temporarily unavailable. The bot will continue running but MOMENTUM strategies won’t execute until BTC prices are available again.
CSV File Location
By default, trades are saved todata/mock_trades.csv relative to the bot directory. Check your .env file for the configured path.
File Structure
After installation, your directory should look like:Updating the Bot
To update to the latest version:Next Steps
Quickstart
Run your first paper trades
Configuration Guide
Deep dive into all configuration options
Strategy Guide
Understand how each trading strategy works
Analysis
Analyze your trade data and performance
Advanced: Virtual Environment (Recommended)
For a cleaner installation, use a Python virtual environment:When using a virtual environment, you need to activate it each time before running the bot.