BinaryOptionsToolsV2 - Python Package

✨ ChipaEditor — AI-powered algorithmic trading strategy builder: describe your edge, get working CHTL code, backtest it, deploy it. Free to start.

📈 Trade crypto perps, spot & margin on ChipaX — demo mode available.

Python bindings for BinaryOptionsTools - A powerful library for automated binary options trading on PocketOption platform.

Current Status

Available Features:

• Authentication: Secure connection with automated SSID sanitization.
• Trading: Instant Buy/Sell operations with real-time result tracking.
• Account: Balance retrieval, opened/closed deals management.
• Market Data: Real-time candle subscriptions (tick to 300s), historical data fetching.
• Resilience: Automated asset gathering, payout synchronization, and robust reconnection logic.
• Advanced: Raw WebSocket handler API and custom message validators.

How to install

Option A: Install from Source (Recommended)

# Clone from GitHub
git clone https://github.com/ChipaDevTeam/BinaryOptionsTools-v2.git
# Or clone from GitLab
# git clone https://gitlab.chipatrade.com/chipadevorg/BinaryOptionsTools-v2.git

cd BinaryOptionsTools-v2/python
git fetch --tags
git checkout "$(git tag -l --sort=-v:refname | head -n 1)"
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install .

Option B: Install from Source Automatically

Requires git, a C toolchain, and a Rust toolchain.

uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
# Install via GitHub
uv pip install "git+https://github.com/ChipaDevTeam/BinaryOptionsTools-v2.git@master#subdirectory=python"
# Or install via GitLab
# uv pip install "git+https://gitlab.chipatrade.com/chipadevorg/BinaryOptionsTools-v2.git@master#subdirectory=python"

Supported OS

Currently supported on Windows, Linux, and macOS.

Supported Python versions

Supports Python 3.8 to 3.13.

Docs

Comprehensive Documentation for BinaryOptionsToolsV2

1. __init__.py

This file initializes the Python module and organizes the imports for both synchronous and asynchronous functionality.

Key Details

• Imports BinaryOptionsToolsV2: Imports all elements and documentation from the Rust module.
• Includes Submodules: Imports and exposes pocketoption and tracing modules for user convenience.

Purpose

Serves as the entry point for the package, exposing all essential components of the library.

Inside the pocketoption folder there are 2 main files

1. asynchronous.py

This file implements the PocketOptionAsync class, which provides an asynchronous interface to interact with Pocket Option.

Key Features of PocketOptionAsync

• Trade Operations:
  • buy(): Places a buy trade asynchronously.
  • sell(): Places a sell trade asynchronously.
  • check_win(): Checks the outcome of a trade ('win', 'draw', or 'loss').
• Market Data:
  • get_candles_live(): Streams real-time gap-free candles (closed and currently forming) with historical backfill.
  • candles() / get_candles(): (Deprecated) Fetches historical candles (delegates to get_candles_live).
  • history(): Retrieves recent historical data for a specific asset through the dedicated history endpoint.
  • compile_candles(): Compiles custom-period candlesticks from base tick data using strict UTC boundaries.
• Account Management:
  • balance(): Returns the current account balance.
  • opened_deals(): Lists all open trades.
  • closed_deals(): Lists all closed trades.
  • payout(): Returns payout percentages.
• Real-Time Data:
  • subscribe_symbol(): Provides an asynchronous iterator for real-time candle updates.
  • subscribe_symbol_timed(): Provides an asynchronous iterator for timed real-time candle updates.
  • subscribe_symbol_chunked(): Provides an asynchronous iterator for chunked real-time candle updates.
• Pending Orders:
  • open_pending_order(): Places a pending limit order.
  • cancel_pending_order(): Cancels a specific pending order by ticket ID.
  • cancel_pending_orders(): Cancels multiple pending orders in a batch.
  • get_pending_deals(): Lists all active pending orders.
  • get_pending_deal(): Retrieves details of a specific pending order.
• Server Information:
  • server_time(): Gets the current server time.
• Connection Management:
  • reconnect(): Manually reconnect to the server.
  • shutdown(): Properly close the connection.
• Advanced / Utilities:
  • wait_for_assets(): Awaits until the assets list is fully loaded from the server.
  • is_demo(): Returns whether the current session is a demo account.
  • is_connected(): Returns connection status.
  • create_raw_handler(): Sets up direct raw WebSocket message listeners with custom validators. Helper Class - AsyncSubscription

Facilitates asynchronous iteration over live data streams, enabling non-blocking operations.

Example Usage

from BinaryOptionsToolsV2.pocketoption import PocketOptionAsync
import asyncio

async def main():
    # Initialize the client
    client = PocketOptionAsync(ssid="your-session-id")

    # Get account balance
    balance = await client.balance()
    print(f"Account Balance: ${balance}")

    # Place a buy trade
    trade_id, deal = await client.buy("EURUSD_otc", 1.0, 60)
    print(f"Trade placed: {deal}")

    # Check result
    result = await client.check_win(trade_id)
    print(f"Trade result: {result}")

    # Subscribe to real-time data
    async for candle in client.subscribe_symbol("EURUSD_otc"):
        print(f"New candle: {candle}")
        break  # Just print one candle for demo

asyncio.run(main())

1. synchronous.py

This file implements the PocketOption class, a synchronous wrapper around the asynchronous interface provided by PocketOptionAsync.

Key Features of PocketOption

• Trade Operations:
  • buy(): Places a buy trade using synchronous execution.
  • sell(): Places a sell trade.
  • check_win(): Checks the trade outcome synchronously.
• Market Data:
  • get_candles_live(): Streams real-time gap-free candles (closed and currently forming) with historical backfill.
  • candles() / get_candles(): (Deprecated) Fetches historical candles (delegates to get_candles_live).
  • history(): Retrieves recent historical data for a specific asset through the dedicated history endpoint.
  • compile_candles(): Compiles custom-period candlesticks from base tick data using strict UTC boundaries.
• Account Management:
  • balance(): Retrieves account balance.
  • opened_deals(): Lists all open trades.
  • closed_deals(): Lists all closed trades.
  • payout(): Returns payout percentages.
• Real-Time Data:
  • subscribe_symbol(): Provides a synchronous iterator for live data updates.
  • subscribe_symbol_timed(): Provides a synchronous iterator for timed real-time candle updates.
  • subscribe_symbol_chunked(): Provides a synchronous iterator for chunked real-time candle updates.
• Pending Orders:
  • open_pending_order(): Places a pending limit order.
  • cancel_pending_order(): Cancels a specific pending order by ticket ID.
  • cancel_pending_orders(): Cancels multiple pending orders in a batch.
  • get_pending_deals(): Lists all active pending orders.
  • get_pending_deal(): Retrieves details of a specific pending order.
• Server Information:
  • server_time(): Gets the current server time.
• Connection Management:
  • reconnect(): Manually reconnect to the server.
  • shutdown(): Properly close the connection.
• Advanced / Utilities:
  • wait_for_assets(): Awaits until the assets list is fully loaded from the server.
  • is_demo(): Returns whether the current session is a demo account.
  • is_connected(): Returns connection status.
  • create_raw_handler(): Sets up direct raw WebSocket message listeners with custom validators. Helper Class - SyncSubscription

Allows synchronous iteration over real-time data streams for compatibility with simpler scripts.

Example Usage

from BinaryOptionsToolsV2.pocketoption import PocketOption
import time

# Initialize the client
client = PocketOption(ssid="your-session-id")

# Get account balance
balance = client.balance()
print(f"Account Balance: ${balance}")

# Place a buy trade
trade_id, deal = client.buy("EURUSD_otc", 1.0, 60)
print(f"Trade placed: {deal}")

# Check result
result = client.check_win(trade_id)
print(f"Trade result: {result}")

# Subscribe to real-time data
stream = client.subscribe_symbol("EURUSD_otc")
for candle in stream:
    print(f"New candle: {candle}")
    break  # Just print one candle for demo

1. Differences Between PocketOption and PocketOptionAsync

Tracing

The tracing module provides functionality to initialize and manage logging for the application.

Key Functions of Tracing

• start_logs():
  • Initializes the logging system for the application.
  • Arguments:
    • path (str): Path where log files will be stored.
    • level (str): Logging level (default is "DEBUG").
    • terminal (bool): Whether to display logs in the terminal (default is True).
  • Returns: None
  • Raises: Exception if there's an error starting the logging system.

Example Usage

from BinaryOptionsToolsV2.tracing import start_logs

# Initialize logging
start_logs(path="logs/", level="INFO", terminal=True)

📖 Detailed Examples

Basic Trading Example (Synchronous)

from BinaryOptionsToolsV2.pocketoption import PocketOption
import time

def main():
    # Initialize client
    client = PocketOption(ssid="your-session-id")

    # Get balance
    balance = client.balance()
    print(f"Current Balance: ${balance}")

    # Place a buy trade on EURUSD for 60 seconds with $1
    trade_id, deal = client.buy(asset="EURUSD_otc", amount=1.0, time=60)
    print(f"Trade ID: {trade_id}")
    print(f"Deal Data: {deal}")

    # Wait for trade to complete (60 seconds)
    time.sleep(65)

    # Check the result
    result = client.check_win(trade_id)
    print(f"Trade Result: {result['result']}")  # 'win', 'loss', or 'draw'
    print(f"Profit: ${result.get('profit', 0)}")

if __name__ == "__main__":
    main()

Basic Trading Example (Asynchronous)

from BinaryOptionsToolsV2.pocketoption import PocketOptionAsync
import asyncio

async def main():
    # Initialize client
    client = PocketOptionAsync(ssid="your-session-id")

    # Get balance
    balance = await client.balance()
    print(f"Current Balance: ${balance}")

    # Place a buy trade on EURUSD for 60 seconds with $1
    trade_id, deal = await client.buy(asset="EURUSD_otc", amount=1.0, time=60)
    print(f"Trade ID: {trade_id}")
    print(f"Deal Data: {deal}")

    # Wait for trade to complete (60 seconds)
    await asyncio.sleep(65)

    # Check the result
    result = await client.check_win(trade_id)
    print(f"Trade Result: {result['result']}")  # 'win', 'loss', or 'draw'
    print(f"Profit: ${result.get('profit', 0)}")

if __name__ == "__main__":
    asyncio.run(main())

Retrieving Historical & Live Candles (Recommended)

To fetch historical backfill and stream gap-free live candles in real-time, use get_candles_live(). This method is available in both async and sync clients. It buffers incoming ticks, merges historical data, and yields updated candles (both closed candles and the forming candle).

Async Example:

from BinaryOptionsToolsV2.pocketoption import PocketOptionAsync
import asyncio

async def main():
    async with PocketOptionAsync(ssid="your-session-id") as client:
        # Stream live candles (yields a tuple: closed_candles list, current_forming_candle dict)
        async for closed, forming in client.get_candles_live("EURUSD_otc", period=60, hours=2.0, max_rows=100):
            print(f"Closed candles count: {len(closed)}")
            if forming:
                print(f"Forming Candle Close Price: {forming['close']}")

if __name__ == "__main__":
    asyncio.run(main())

Sync Example:

from BinaryOptionsToolsV2.pocketoption import PocketOption

client = PocketOption(ssid="your-session-id")
# Iterate over live candles
for closed, forming in client.get_candles_live("EURUSD_otc", period=60, hours=2.0, max_rows=100):
    print(f"Closed candles count: {len(closed)}")
    if forming:
        print(f"Forming Candle Close Price: {forming['close']}")

Deprecated Candle Methods

The duplicate candle functions candles() and get_candles() are deprecated and will be removed in a future release.

• Reason: They only fetch closed historical candles, can introduce gaps when called sequentially during live trading, and do not include the currently forming candle.
• Compatibility: To preserve backward compatibility, these methods have been redirected to run get_candles_live() internally under the hood (returning the first yielded list of closed candles).

Compiling Custom Period Candles

from BinaryOptionsToolsV2.pocketoption import PocketOptionAsync
import asyncio

async def main():
    client = PocketOptionAsync(ssid="your-session-id")

    # Compile 5-minute candles from 1-minute base data
    # Parameters: asset, custom_period, lookback_period
    candles = await client.compile_candles("EURUSD_otc", 60, 300)

    print(f"Compiled {len(candles)} custom candles")
    if candles:
        print("Latest compiled candle:", candles[-1])

if __name__ == "__main__":
    asyncio.run(main())

Real-Time Data Subscription (Synchronous)

from BinaryOptionsToolsV2.pocketoption import PocketOption
import time

def main():
    client = PocketOption(ssid="your-session-id")

    # Subscribe to real-time candle data
    stream = client.subscribe_symbol("EURUSD_otc")

    print("Listening for real-time candles...")
    for candle in stream:
        print(f"Time: {candle.get('time')}")
        print(f"Open: {candle.get('open')}")
        print(f"High: {candle.get('high')}")
        print(f"Low: {candle.get('low')}")
        print(f"Close: {candle.get('close')}")
        print("---")

if __name__ == "__main__":
    main()

Real-Time Data Subscription (Asynchronous)

from BinaryOptionsToolsV2.pocketoption import PocketOptionAsync
import asyncio

async def main():
    client = PocketOptionAsync(ssid="your-session-id")

    # Subscribe to real-time candle data
    async for candle in client.subscribe_symbol("EURUSD_otc"):
        print(f"Time: {candle.get('time')}")
        print(f"Open: {candle.get('open')}")
        print(f"High: {candle.get('high')}")
        print(f"Low: {candle.get('low')}")
        print(f"Close: {candle.get('close')}")
        print("---")

if __name__ == "__main__":
    asyncio.run(main())

Checking Opened Deals

from BinaryOptionsToolsV2.pocketoption import PocketOption
import time

def main():
    client = PocketOption(ssid="your-session-id")

    # Get all opened deals
    opened_deals = client.opened_deals()

    if opened_deals:
        print(f"You have {len(opened_deals)} opened deals:")
        for deal in opened_deals:
            print(f"  - Trade ID: {deal.get('id')}")
            print(f"    Asset: {deal.get('asset')}")
            print(f"    Amount: ${deal.get('amount')}")
            print(f"    Direction: {deal.get('action')}")
    else:
        print("No opened deals")

if __name__ == "__main__":
    main()

🔑 Important Notes

Connection Initialization

The client automatically establishes a connection during initialization. You can also manually manage the connection using connect(), disconnect(), and reconnect() methods.

# Asynchronous
client = PocketOptionAsync(ssid="your-session-id")
# Connection is already established here

# Manual control
await client.disconnect()
await client.connect()

# Synchronous
client_sync = PocketOption(ssid="your-session-id")
# Connection is already established here

# Manual control
client_sync.disconnect()
client_sync.connect()

Getting Your SSID

1. Go to PocketOption
2. Open Developer Tools (F12)
3. Go to Application/Storage → Cookies
4. Find the cookie named ssid
5. Copy its value

Supported Assets

Common assets include:

• EURUSD_otc - Euro/US Dollar (OTC)
• GBPUSD_otc - British Pound/US Dollar (OTC)
• USDJPY_otc - US Dollar/Japanese Yen (OTC)
• AUDUSD_otc - Australian Dollar/US Dollar (OTC)
• And many more...

Use _otc suffix for over-the-counter (24/7 available) assets.

📚 Additional Resources

• Full Examples: docs/examples/python
• API Documentation: https://chipatrade.gitlab.io/chipadevorg/BinaryOptionsTools-v2/python.html
• Discord Community: Join us

⚠️ Risk Warning

Trading binary options involves substantial risk and may result in the loss of all invested capital. This library is provided for educational purposes only. Always trade responsibly and never invest more than you can afford to lose.