Skip to content

Home

Jump to bottom
Beydah Saglam edited this page Sep 24, 2025 · 2 revisions

ByBit Trading Bot - Wiki

Welcome to the official wiki for the ByBit Trading Bot! This document serves as the central hub for all documentation related to the project.

📚 Table of Contents

  1. Introduction
  2. Features
  3. Architecture
  4. Installation Guide
  5. Configuration
  6. Usage
  7. Trading Strategy
  8. Telegram Bot Commands
  9. Troubleshooting
  10. FAQ
  11. Contributing
  12. License

🌟 Introduction

The ByBit Trading Bot is an automated trading solution that implements advanced technical analysis strategies, focusing on the ZigZag pattern recognition algorithm similar to TradingView's implementation. The bot is designed to work with the ByBit cryptocurrency exchange and features a user-friendly PyQt6 interface along with Telegram integration for remote monitoring and control.

🚀 Features

Core Trading Features

  • ZigZag Pattern Recognition: Identifies significant market turning points
  • Multi-timeframe Analysis: Scans multiple timeframes for confirmation
  • Fibonacci Retracement: Calculates key levels for entry and exit points
  • Real-time Market Scanning: Continuously monitors the market for opportunities
  • Risk Management: Implements stop-loss and take-profit strategies

User Interface

  • Modern PyQt6 Interface: Clean and responsive design
  • Real-time Monitoring: Track bot performance and market conditions
  • Trading Dashboard: View open positions, P&L, and trading history
  • Configuration Panel: Easily adjust trading parameters

Integration

  • ByBit API Integration: Direct connection to ByBit exchange
  • Telegram Bot: Remote monitoring and control
  • Automated Trading: Execute trades based on predefined strategies

🏗 Architecture

System Components

bybit_bot_v4/
├── a_view/           # User interface components
│   └── view.py      # Main window and UI components
├── b_controller/     # Application logic
│   └── controller.py # Main controller and business logic
├── c_service/        # Core services
│   ├── a_bybit.py    # ByBit API interactions
│   ├── b_strategy.py # Trading strategies
│   ├── c_scanner.py  # Market scanner
│   ├── d_telegram.py # Telegram bot
│   ├── e_transaction.py # Trade execution
│   └── f_signal.py   # Signal processing
├── d_model/          # Data models
│   ├── b_bybit.py    # ByBit data models
│   ├── d_telegram.py # Telegram data models
│   ├── e_message.py  # Message handling
│   └── f_log.py      # Logging system
└── main.py          # Application entry point

Data Flow

  1. Market Data Collection: Fetches real-time market data from ByBit
  2. Signal Generation: Analyzes data using ZigZag and other technical indicators
  3. Decision Making: Determines trading actions based on strategy
  4. Order Execution: Places trades on ByBit exchange
  5. Monitoring: Trades are monitored and managed according to strategy
  6. Notification: Sends updates via Telegram

🛠 Installation Guide

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)
  • Git

Setup Steps

  1. Clone the repository

    git clone https://github.com/beydah/ByBit-Scanner-Bot.git
cd ByBit-Scanner-Bot

  2. Create and activate a virtual environment

    # Windows
python -m venv venv
.\venv\Scripts\activate

# Unix or MacOS
python3 -m venv venv
source venv/bin/activate

  3. Install dependencies

    pip install -r requirements.txt

  4. Configure the bot

    • Copy .env.example to .env
    • Update the values in .env with your configuration

⚙ Configuration

Environment Variables

Create a .env file in the root directory with the following variables:

# ByBit API
BYBIT_API_KEY=your_api_key_here
BYBIT_API_SECRET=your_api_secret_here
BYBIT_TESTNET=false  # Set to true for testing

# Telegram Bot
TELEGRAM_BOT_TOKEN=your_telegram_bot_token
ADMIN_CHAT_IDS=123456789,987654321  # Comma-separated list of admin chat IDs

# Trading Parameters
TRADING_PAIR=BTCUSDT
TRADE_AMOUNT=10  # USDT amount per trade
LEVERAGE=10
STOP_LOSS_PERCENT=2
TAKE_PROFIT_PERCENT=4

# Scanner Settings
SCAN_INTERVAL=300  # seconds
MAX_OPEN_POSITIONS=5

# Logging
LOG_LEVEL=INFO
LOG_FILE=bot.log

🎮 Usage

Starting the Bot

python main.py

Using the GUI

  1. Dashboard: View account balance, open positions, and bot status
  2. Scanner: Configure and control the market scanner
  3. Trades: Monitor and manage open positions
  4. Settings: Adjust bot configuration
  5. Logs: View system and trade logs

Using Telegram

Send /start to your bot to see available commands:

  • /status - Check bot status
  • /balance - View account balance
  • /positions - List open positions
  • /start_trading - Start automated trading
  • /stop_trading - Stop automated trading
  • /help - Show available commands

📈 Trading Strategy

ZigZag Pattern Recognition

The bot uses a custom implementation of the ZigZag indicator to identify significant market turning points. The algorithm:

  1. Identifies local highs and lows in price action
  2. Filters out insignificant price movements using configurable parameters
  3. Labels patterns as Higher Highs (HH), Lower Highs (LH), Higher Lows (HL), or Lower Lows (LL)
  4. Generates trading signals based on pattern confirmation

Fibonacci Retracement

For each identified pattern, the bot calculates key Fibonacci levels:

  • 23.6%
  • 38.2%
  • 50.0%
  • 61.8%
  • 78.6%

These levels are used to determine potential entry, stop-loss, and take-profit points.

Risk Management

  • Position sizing based on account balance
  • Stop-loss orders to limit losses
  • Take-profit targets to secure profits
  • Maximum number of concurrent positions
  • Daily loss limits

🤖 Telegram Bot Commands

User Commands

  • /start - Start the bot and show main menu
  • /help - Show help message
  • /status - Show bot status
  • /balance - Show account balance
  • /positions - List open positions
  • /trades - Show recent trades
  • /pnl - Show profit and loss

Admin Commands

  • /start_trading - Start automated trading
  • /stop_trading - Stop automated trading
  • /restart - Restart the bot
  • /config - View or modify configuration
  • /logs - View bot logs

🛠 Troubleshooting

Common Issues

  1. API Connection Errors

    • Verify your API keys
    • Check your internet connection
    • Ensure your IP is whitelisted on ByBit

  2. Authentication Failures

    • Verify API key permissions
    • Check API key expiration
    • Ensure system clock is synchronized

  3. Order Execution Issues

    • Check available balance
    • Verify trading pair is active
    • Check for exchange maintenance

Viewing Logs

Logs are stored in bot.log by default. You can also view logs in the GUI or via Telegram.

❓ Frequently Asked Questions

General

Q: Is this bot free to use? A: Yes, the bot is open-source and free to use under the MIT License.

Q: What exchanges does the bot support? A: Currently, the bot supports ByBit exchange.

Q: Can I run multiple instances of the bot? A: Yes, but you should ensure they don't interfere with each other's trading.

Trading

Q: What's the minimum account balance required? A: The minimum depends on your trading parameters, but we recommend at least $100 for proper risk management.

Q: Can I customize the trading strategy? A: Yes, you can modify the strategy in c_service/b_strategy.py.

Q: How often does the bot place trades? A: The bot scans the market at intervals defined in the configuration (default: 5 minutes).

🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md for guidelines.

📜 License

This project is licensed under the GNU License - see the LICENSE file for details.

Disclaimer: Trading cryptocurrencies involves substantial risk of loss. This bot is for educational purposes only. Always test with small amounts first and never invest more than you can afford to lose.

Developer Information

Clone this wiki locally