Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/openbullet/captchasharp

.NET universal interface for the Web APIs of all major captcha solving services
https://github.com/openbullet/captchasharp

captcha captcha-bypass captcha-solver captcha-solving csharp csharp-lib csharp-library funcaptcha hcaptcha recaptcha recaptcha-v2 recaptcha-v3 turnstile

Last synced: about 1 month ago
JSON representation

.NET universal interface for the Web APIs of all major captcha solving services

Host: GitHub
URL: https://github.com/openbullet/captchasharp
Owner: openbullet
License: mit
Created: 2020-04-09T03:47:39.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-12T20:31:38.000Z (3 months ago)
Last Synced: 2024-10-12T14:21:40.896Z (about 1 month ago)
Topics: captcha, captcha-bypass, captcha-solver, captcha-solving, csharp, csharp-lib, csharp-library, funcaptcha, hcaptcha, recaptcha, recaptcha-v2, recaptcha-v3, turnstile
Language: C#
Homepage:
Size: 717 KB
Stars: 92
Watchers: 8
Forks: 22
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # CaptchaSharp

A .NET library that implements the APIs of the most used **captcha solving services** out there.

The library is fully documented, asynchronous and very easy to use.

All services derive from the same `CaptchaService` class and have the same code API, so it's very easy to switch between services!

## Supported Services

This library supports the following captcha solving services

- [2captcha.com](https://2captcha.com/)

- [anti-captcha.com](https://anti-captcha.com/)

- [deathbycaptcha.com](https://deathbycaptcha.com/)

- [imagetyperz.com](https://www.imagetyperz.com/)

- [capmonster.cloud](https://capmonster.cloud/)

- [captchacoder.com](https://captchacoder.com/)

- [humancoder.com](https://humancoder.com/)

- [azcaptcha.com](https://azcaptcha.com/)

- [captchas.io](https://captchas.io/)

- [9kw.eu](https://www.9kw.eu/)

- [truecaptcha.com](https://truecaptcha.com/)

- [rucaptcha.com](https://rucaptcha.com/)

- [nopecha.com](https://nopecha.com/)

- [nocaptchaai.com](https://nocaptchaai.com/)

- [metabypass.tech](https://metabypass.tech/)

- [captchaai.com](https://captchaai.com/)

- [nextcaptcha.com](https://nextcaptcha.com/)

- [ez-captcha.com](https://ez-captcha.com/)

- [endcaptcha.com](https://endcaptcha.com/)

- [bestcaptchasolver.com](https://bestcaptchasolver.com/)

- [solvecaptcha.net](https://solvecaptcha.net/)

- [cap.guru](https://cap.guru/)

- [aycd.io](https://aycd.io/)

- [capsolver.com](https://capsolver.com/)

## Supported Captcha Types

This library supports the following captcha types

- Text (with language options)

- Image (with options like phrase, case sensitivity, calculations)

- ReCaptcha v2 (incl. invisible, enterprise)

- ReCaptcha v3 (incl. enterprise)

- ArkoseLabs FunCaptcha

- HCaptcha (incl. invisible, enterprise)

- KeyCaptcha

- GeeTest v3

- GeeTest v4

- Capy

- DataDome

- Cloudflare Turnstile

- Cloudflare Challenge page

- Lemin Cropped

- Amazon WAF

- Cyber SiARA

- MT Captcha

- CutCaptcha

- Friendly Captcha

- atb Captcha

- Tencent Captcha

- Audio Captcha (with language options)

- ReCaptcha Mobile

Additional supported features:

- Proxies

- User-Agent

- Cookies

## Availability Table

![Availability Table Logo](availability_table_logo.png?raw=true)

**Not every captcha type is supported by each service! You can find a spreadsheet with a breakdown of the supported captcha types for each implemented service at the link below**

[CaptchaSharp Services Availability](https://1drv.ms/x/s!Al8HxSfx2JL3ePfRK23aUt34eCk?e=WNCPh9)

## Adding CaptchaSharp to your project

Simply install the nuget package via

`Install-Package CaptchaSharp`

## Usage

First of all, initialize your solver of choice by providing your credentials, for example

```csharp

CaptchaService service = new TwoCaptchaService("MY_API_KEY");

```

You can get your remaining balance like this

```csharp

decimal balance = await service.GetBalanceAsync();

```

If the provided credentials are wrong, the method above will return a `BadAuthenticationException`.

If the credentials are correct and the balance is greater than the minimum required for solving a captcha, you can proceed to solve a captcha (e.g., a ReCaptchaV2 task) like this.

```csharp

StringResponse solution = await service.SolveRecaptchaV2Async("site key", "site url");

```

The method above can throw the following exceptions:

- `TaskCreationException` when the task could not be created, for example due to zero balance or incorrect parameters.

- `TaskSolutionException` when the task could not be completed, for example when an image captcha cannot be decoded.

- `TimeoutException` when the captcha solution took too long to complete.

You can configure a custom timeout like this

```csharp

service.Timeout = TimeSpan.FromMinutes(3);

```

The returned solution will contain two fields:

-   an `Id` which you can use for reporting a bad solution (if the service supports it) like this

    ```csharp

    await service.ReportSolutionAsync(solution.Id, CaptchaType.ReCaptchaV2);

    ```

    if the report failed, the method above will throw a `TaskReportException`.

-   your solution as plaintext

    ```csharp

    Console.WriteLine($"The solution is {solution.Response}");

    ```

If a method or some of its parameters are not supported, a `NotSupportedException` or `ArgumentException` will be thrown.

## Proxy, User-Agent, and Cookies

Some services and captcha types can accept additional parameters, like a proxy, user-agent, or cookies.

```csharp

var sessionParams = new SessionParams

{

    Proxy = new Proxy(

        host: "proxy.example.com",

        port: 8080,

        type: ProxyType.HTTP,

        username: "proxy_username", // optional

        password: "proxy_password" // optional

    ),

    UserAgent = "Mozilla/5.0 ...", // make sure to use an up-to-date user-agent

    Cookies = new Dictionary

    {

        { "cookie_name_1", "cookie_value_1" },

        { "cookie_name_2", "cookie_value_2" }

    }

};

// Solve a captcha with session parameters

StringResponse solution = await service.SolveRecaptchaV2Async(

    "site key", "site url", sessionParams: sessionParams);

Console.WriteLine($"The solution is {solution.Response}");

```

All session parameters are optional, and you can provide only the ones you need.

## The service I want to use is not implemented

If the service you want to use is not implemented, you can easily implement it yourself by deriving from the `CaptchaService` class and implementing the abstract methods, or you can open an issue, and we will try to implement it as soon as possible.

## Unit Tests

Unit tests are included in the `CaptchaSharp.Tests` project. In order to test, you need to:

1. Run any test once and let it fail. It will create a file called `config.json` in your `bin/Debug/net8.0` folder.

2. Add your credentials to the `config.json` file. You can also add a proxy to test proxied endpoints.

3. Run the tests (one at a time, to avoid overloading the service and overspending).

4. If you need to test a captcha on a specific website, you can edit the `ServiceTests` class and change the parameters as you need.

## What needs to be improved

- Drop `Newtonsoft.Json` for `System.Text.Json`

- Implement better exception handling for specific error codes. For example when there is zero balance or when a solver method returns a bad authentication, they will currently fall in the generic `TaskCreationException` type.

- Add support for recognition APIs (right now only token-based APIs are supported).