An open API service indexing awesome lists of open source software.

https://github.com/alperensert/capmonster_python

Capmonster.cloud library for Python3
https://github.com/alperensert/capmonster_python

async-python capmonster capmonster-cloud captcha-bypass captcha-solving cloudflare-bypass pydantic recaptcha-v2 task-automation

Last synced: 3 days ago
JSON representation

Capmonster.cloud library for Python3

Awesome Lists containing this project

README

          

# ๐Ÿค– Capmonster Python

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/capmonster-python?style=for-the-badge)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/alperensert/capmonster_python?style=for-the-badge)
![GitHub last commit](https://img.shields.io/github/last-commit/alperensert/capmonster_python?style=for-the-badge)
![GitHub Release](https://img.shields.io/github/v/release/alperensert/capmonster_python?style=for-the-badge)
![GitHub Repo stars](https://img.shields.io/github/stars/alperensert/capmonster_python?style=for-the-badge&color=rgb(255%2C%20255%2C%20143)&cacheSeconds=3600)

A modern, strongly typed, async-friendly Python SDK for solving CAPTCHA challenges
using [Capmonster.Cloud](https://capmonster.cloud/).

Supports reCAPTCHA v2 & v3, Cloudflare Turnstile, GeeTest (v3 & v4) and [much more](#-supported-captcha-types).

---

## โœจ Features

- โœ… Fully typed Pydantic v2 models
- ๐Ÿ” Both sync and async API support
- ๐Ÿ” Proxy and User-Agent configuration
- ๐Ÿ“ฆ Supports the most common CAPTCHA types
- ๐Ÿ“š Intuitive API with powerful task building

---

## ๐Ÿ”ง Installation

```bash
pip install capmonster_python
```

> [!IMPORTANT]
> You're viewing the documentation for **Capmonster Python v4**, which includes breaking changes. If you prefer the
> old syntax used in versions prior to 4.x, you can continue using it by installing the legacy version:
> ```pip install capmonster_python==3.2```

## ๐Ÿš€ Quick Start

### Async Example

```python
import asyncio
from capmonster_python import CapmonsterClient, RecaptchaV3Task

async def main():
client = CapmonsterClient(api_key="YOUR_API_KEY")

task = RecaptchaV3Task(
websiteURL="https://example.com",
websiteKey="SITE_KEY_HERE",
minScore=0.5,
pageAction="verify"
)

task_id = await client.create_task_async(task)
result = await client.join_task_result_async(task_id)
print(result)

asyncio.run(main())

```

### Sync Example

```python
from capmonster_python import CapmonsterClient, RecaptchaV2Task

client = CapmonsterClient(api_key="")

task = RecaptchaV2Task(
websiteURL="https://example.com",
websiteKey="SITE_KEY_HERE"
)

task_id = client.create_task(task)
result = client.join_task_result(task_id)
print(result)
```

---

## ๐Ÿง  Supported CAPTCHA Types

Capmonster Python v4 supports a wide range of CAPTCHA formats โ€” from mainstream challenges like reCAPTCHA and Turnstile
to enterprise-grade shields like Imperva and DataDome. Each task supports full Pydantic validation โœ… and both sync and
async clients ๐Ÿ”„ unless noted.

| ๐Ÿ”– Category | CAPTCHA Type | Class Name | Proxy Required | Notes |
|---------------------------|--------------------------------|-------------------------------|----------------|----------------------------------------|
| ๐Ÿงฉ reCAPTCHA | reCAPTCHA v2 | `RecaptchaV2Task` | Optional | Visible / Invisible supported โœ… ๐Ÿ”„ |
| | reCAPTCHA v2 Enterprise | `RecaptchaV2EnterpriseTask` | Optional | `enterprisePayload` & `apiDomain` โœ… ๐Ÿ”„ |
| | reCAPTCHA v3 | `RecaptchaV3Task` | โŒ No | Score-based, proxyless โœ… ๐Ÿ”„ |
| ๐Ÿ›ก๏ธ Cloudflare | Turnstile (token) | `TurnstileTask` | โŒ No | Lightweight, async-ready โœ… ๐Ÿ”„ |
| | Turnstile (cf_clearance) | `TurnstileCloudFlareTask` | โœ… Yes | Full HTML + proxy required โœ… ๐Ÿ”„ |
| ๐Ÿ“ธ Image-based | Image-to-Text OCR | `ImageToTextTask` | โŒ No | Base64 image + module control โœ… ๐Ÿ”„ |
| | Complex Image (Recaptcha-like) | `ComplexImageRecaptchaTask` | โŒ No | Grid-based, metadata aware โœ… ๐Ÿ”„ |
| | Complex Image Recognition (AI) | `ComplexImageRecognitionTask` | โŒ No | Supports tasks like Shein, OOCL โœ… ๐Ÿ”„ |
| ๐Ÿง  Human Behavior | GeeTest v3 | `GeeTestV3Task` | Optional | Challenge + `gt` key + freshness โœ… ๐Ÿ”„ |
| | GeeTest v4 | `GeeTestV4Task` | Optional | `initParameters` supported โœ… ๐Ÿ”„ |
| ๐Ÿ›ก๏ธ Enterprise Protection | DataDome | `DataDomeTask` | โœ… Recommended | Cookie & page context needed โœ… ๐Ÿ”„ |
| | Imperva | `ImpervaTask` | โœ… Recommended | Incapsula + Reese84 logic โœ… ๐Ÿ”„ |
| ๐Ÿฆ Platform-Specific | Binance Login | `BinanceTask` | โœ… Yes | `validateId` for login flow โœ… ๐Ÿ”„ |
| | Temu | `TemuTask` | โŒ No | Cookie-injected behavioral solver โœ… ๐Ÿ”„ |
| | TenDI | `TenDITask` | โœ… Yes | Custom captchaAppId field โœ… ๐Ÿ”„ |
| ๐Ÿงช Miscellaneous | Prosopo | `ProsopoTask` | Optional | Used in zk or crypto UIs โœ… ๐Ÿ”„ |
| | Basilisk | `BasiliskTask` | โŒ No | Minimalist site-key puzzle โœ… ๐Ÿ”„ |

## ๐Ÿงฉ Advanced Usage

- Callback URLs are supported during task creation.
- Includes auto-retry loop for polling results (up to 120s)

## ๐Ÿ’ฌ Community & Support

Need help or have a question?

- ๐Ÿ“ง Contact: business@alperen.io
- ๐Ÿ› Found a bug? [Open an issue](https://github.com/alperensert/capmonster_python/issues)

> [!NOTE]
> Community support is intended only for questions and issues related to this project. Custom usage scenarios,
> integrations, or application-specific logic are outside the scope of support.

## ๐Ÿ“„ License

This project is licensed under the [MIT License](/LICENSE).