CryptoByPlanBITVAVO TRADING CO-PILOTInstall CryptoByPlan
CryptoByPlan runs on a computer or device you manage. It connects to your Bitvavo account and Telegram bot; your credentials, configuration, and trading history stay on your machine.
Choose your platform
macOS
Python 3.12, a source archive, and optional start-at-login setup.
Windows 11
64-bit Windows, Python 3.12, a ZIP package, and optional Task Scheduler setup.
Raspberry Pi / Linux ARM64
Raspberry Pi 4 with Ubuntu Server 24.04 LTS (64-bit), Python 3.12, and optional systemd startup.
Desktop Linux x86_64 is not included in the current supported targets.
Before you install
- Create your own Telegram bot with @BotFather and use a Bitvavo API key with trading access and withdrawals disabled.
- Use one active CryptoByPlan instance per Bitvavo account. A second API key still connects to the same account; it does not create separate balances or open orders.
- CryptoByPlan places real spot orders when you configure trading plans and their conditions are met. There is no paper-trading mode. Begin with the read-only check described in your platform guide.
Fill in .env exactly
Setup creates a local .env file. Replace the example text on the right of each equals sign with your own values. Keep the variable names on the left unchanged.
BITVAVO_API_KEY=PASTE_YOUR_BITVAVO_API_KEY_HERE
BITVAVO_API_SECRET=PASTE_YOUR_BITVAVO_API_SECRET_HERE
TELEGRAM_TOKEN=PASTE_YOUR_BOTFATHER_TOKEN_HERE
TELEGRAM_CHAT_ID=PASTE_YOUR_NUMERIC_CHAT_ID_HERE
CMC_API_KEY=
- Remove each
PASTE_..._HEREplaceholder and enter your value. Do not type angle brackets or quotation marks. Use no spaces around=. TELEGRAM_CHAT_IDis digits only. The platform guides explain how to find it using your own Telegram bot.CMC_API_KEYis optional. Leave it blank if you do not want CoinMarketCap context. It adds BTC-dominance and global market-cap/volume context; it is not used for orders or sizing.
To use CoinMarketCap context, create a key in the CoinMarketCap API account portal and follow its key-location instructions. Never share your .env file or include it in screenshots.
Start safely
1. Review
Check the generated config.yaml and confirm your Telegram and Bitvavo credentials are your own. A new install starts with no DCA plan or manual Smart orders.
2. Run once in the foreground
Start one instance and verify /start, /status, /balances, /orders, and /help. Do not create an order or DCA plan during this check.
3. Choose automatic startup
Only after the check passes, optionally enable the platform’s background startup. Know how to stop it before you configure trading.
What starts automatically?
- macOS: LaunchAgent runs at your next login and when deliberately loaded; it does not automatically restart after a crash.
- Windows: optional Task Scheduler task runs when your Windows user signs in; it does not restart after a crash.
- Raspberry Pi / Linux: systemd can start at boot without login and restarts after failure with a 10-second delay.
These installation guides are published ahead of the public beta. Platform acceptance is still in progress, so no public download is available yet.