CaptchaSharp 1.0.11

CaptchaSharp

A .NET Standard 2.0 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 so you can allow users to use their favourite service without the need of a separate library for each one of them!

Supported Captchas

This library supports the following captcha types

• Text (with language options)
• Image (with options like phrase, case sensitivity, calculations)
• FunCaptcha
• ReCaptcha V2 (incl. invisible, enterprise)
• ReCaptcha V3 (incl. enterprise)
• HCaptcha
• KeyCaptcha
• GeeTest
• Capy

Although this sounds very exciting, sadly not all captcha types are supported by the services. You can find a table of the supported captcha types for each major service below.

Adding CaptchaSharp to your project

Simply install the nuget package via

Install-Package CaptchaSharp

If you need more solvers you can install additional solvers (mostly ones that implement the 2captcha API) like this

Install-Package CaptchaSharp.Services.More

Usage

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

CaptchaService service = new TwoCaptchaService("MY_API_KEY");

You can get your remaining balance like this

decimal balance = await service.GetBalanceAsync();

If the provided credentials are wrong, the method above will return a BadAuthenticationException that you can catch and process in order to let the user know he needs to check his credentials.

If the credentials are correct and the balance is greater than the minimum required for solving a captcha, we can proceed to solve a ReCaptchaV2 task (you will need to provide the required parameters found in the webpage source code).

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

service.Timeout = TimeSpan.FromMinutes(3);

The returned StringResponse will contain two fields:

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

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

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

And finally your solution as plaintext

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

In addition, mind that not every service supports every type of captcha! If a method or specific parameters are not supported, a NotSupportedException will be thrown.

Unit Tests

Unit tests for the major services 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 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

• Use C# anonymous types or JObject for the AntiCaptchaSolver instead of a million classes!
• Implement better exception handling, 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.