capbypass-sdk 1.0.5

Official Python SDK for CapBypass CAPTCHA solving API

CapBypass Python SDK

Official Python SDK for the CapBypass CAPTCHA solving API.

Features

• ✨ Simple solve() method with auto-polling
• 🎯 Advanced createTask() + getTaskResult() for granular control
• 💰 getBalance() to check account balance
• 🔄 Automatic retry logic for network failures
• 🛡️ Comprehensive error handling
• 📝 Type hints for better IDE support
• 🧪 100% test coverage

Supported CAPTCHA Types

• reCAPTCHA v2 (normal & invisible)
• reCAPTCHA v3
• reCAPTCHA v3 Enterprise
• AWS WAF CAPTCHA

Installation

pip install capbypass-sdk

Quick Start

from capbypass import CapBypass

# Initialize client
client = CapBypass(api_key="your-api-key")
# Or use environment variable: export CAPBYPASS_API_KEY="your-key"

# Solve CAPTCHA (auto-polling)
solution = client.solve({
    "type": "ReCaptchaV2TaskProxyLess",
    "websiteURL": "https://example.com",
    "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
})

print(solution["gRecaptchaResponse"])

Advanced Usage

Granular Control

# Create task
task_id = client.createTask({
    "type": "ReCaptchaV2TaskProxyLess",
    "websiteURL": "https://example.com",
    "websiteKey": "site-key"
})

# Poll for result
import time
while True:
    result = client.getTaskResult(task_id)
    if result["status"] == "ready":
        print(result["solution"])
        break
    time.sleep(5)

Check Balance

balance = client.getBalance()
print(f"Balance: ${balance:.4f}")

Error Handling

from capbypass import CapBypass
from capbypass.errors import (
    AuthenticationError,
    InsufficientBalanceError,
    TimeoutError,
)

try:
    solution = client.solve(task)
except AuthenticationError:
    print("Invalid API key")
except InsufficientBalanceError:
    print("Insufficient balance")
except TimeoutError:
    print("Task timed out")

Documentation

📚 Core Documentation

• Quick Start Guide
• Complete API Reference
• Full SDK Documentation

🔧 Advanced Guides

• Proxy Configuration — HTTP, HTTPS, SOCKS5 proxy support with rotation strategies
• Error Handling — Retry strategies, circuit breakers, production alerting
• Performance Optimization — Concurrent solving, connection pooling, token caching
• Production Deployment — Kubernetes, AWS Lambda, monitoring, security

🔄 Migration

• Migrating from Capsolver — 100% API compatible, drop-in replacement

Examples

Basic Examples

See examples/ directory for complete runnable examples:

• recaptcha_v2.py - reCAPTCHA v2 solving
• recaptcha_v3.py - reCAPTCHA v3 solving
• aws_waf.py - AWS WAF CAPTCHA solving

Advanced Examples

Full integration examples in the documentation:

• E-commerce checkout automation
• Social media automation
• Web scraping with CAPTCHA handling
• Microservice integration patterns

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run linter
ruff check .

# Run type checker
mypy src/

License

MIT

Support

• Website
• Documentation
• Dashboard / Sign up
• Pricing
• Discord
• Issues: https://github.com/CapBypass-Development/capbypass-sdk-python/issues