Skip to main content

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

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.10.tar.gz (10.6 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.10-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: capbypass_sdk-1.0.10.tar.gz
  • Upload date:
  • Size: 10.6 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.10.tar.gz
Algorithm Hash digest
SHA256 8ea3dbb9c70fd93cb6659757a5516b8d78b94a914f31b28e2f0eab677aceda80
MD5 f7790bbcec0c0896b0e731706fdcffcc
BLAKE2b-256 8b6866dcaa1ca62c3eb8ecc15350a937a77c5eefe9a8da6ebee75ee5d0f86443

See more details on using hashes here.

File details

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

File metadata

  • Download URL: capbypass_sdk-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 9.5 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 c1476500e5b3ead4ee8a3ed326fe5e54f88cc066888daa361e0e1c9b385030cc
MD5 f715bbaa97f64d6b2b35ee2e0835f772
BLAKE2b-256 f5e5daf4aef39eeddac51016a5818afc30c492133494e036d72a44d7d7abede5

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.10 This release

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.0

2 files

Supported by

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