Skip to main content

Official Python SDK for CapBypass CAPTCHA solving API

Project description

CapBypass Python SDK

PyPI version Python versions Downloads GitHub stars

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

🔧 Advanced Guides

🔄 Migration

Examples

Basic Examples

See examples/ directory for complete runnable examples:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

capbypass_sdk-1.0.7.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

capbypass_sdk-1.0.7-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file capbypass_sdk-1.0.7.tar.gz.

File metadata

  • Download URL: capbypass_sdk-1.0.7.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for capbypass_sdk-1.0.7.tar.gz
Algorithm Hash digest
SHA256 9a732140950e309df66eb8eaf8d2ec6855a477b0d36f2b2a0fdcab1c13af7e0e
MD5 b0e47adbd7d90e8b2c8347a894a76242
BLAKE2b-256 54ada8dd8501d72bc2d119f7497ecf25c23f14f68e983539aa8548dac2048982

See more details on using hashes here.

File details

Details for the file capbypass_sdk-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: capbypass_sdk-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for capbypass_sdk-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a187075cd7ff1679c2317a5919768dbf0506eb766ad2580f77bf5852d85144d5
MD5 c3aa3e02a38727a101ed4df7dcee7be5
BLAKE2b-256 f974c2e4c2b78c0aa5ea064bb1fee510d02f1f19e6ded6fe539d0ca47a917bf0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page