Skip to content

Latest commit

 

History

History
588 lines (449 loc) · 23.4 KB

README.md

File metadata and controls

588 lines (449 loc) · 23.4 KB

JAVA Module for 2Captcha API (captcha solver)

The easiest way to quickly integrate 2Captcha into your code to automate solving of any types of captcha. Examples of API requests for different captcha types are available on the Java captcha solver page.

Installation

2captcha-java artifact is available in Maven Central

Configuration

TwoCaptcha instance can be created like this:

TwoCaptcha solver = new TwoCaptcha('YOUR_API_KEY');

Also there are few options that can be configured:

solver.setHost("2captcha.com");
solver.setSoftId(123);
solver.setCallback("https://your.site/result-receiver");
solver.setDefaultTimeout(120);
solver.setRecaptchaTimeout(600);
solver.setPollingInterval(10);
solver.setExtendedResponse(1);

TwoCaptcha instance options

Option Default value Description
host 2captcha.com API server. You can set it to rucaptcha.com if your account is registered there
softId 4581 your software ID obtained after publishing in 2captcha software catalog
callback - URL of your web-sever that receives the captcha recognition result. The URl should be first registered in pingback settings of your account
defaultTimeout 120 Polling timeout in seconds for all captcha types except reCAPTCHA. Defines how long the module tries to get the answer from res.php API endpoint
recaptchaTimeout 600 Polling timeout for reCAPTCHA in seconds. Defines how long the module tries to get the answer from res.php API endpoint
pollingInterval 10 Interval in seconds between requests to res.php API endpoint, setting values less than 5 seconds is not recommended
extendedResponse 0 Json or String format response from res.php API endpoint, extendedResponse = 1 returns JSON format response. Suitable for ClickCaptcha, Canvas

Important

Once callback URL is defined for TwoCaptcha instance with setCallback, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL. To get the answer manually use getResult method

Tip

Use the extendedResponse(1) setting to obtain an extended response for the captcha. When using extendedResponse(1), the response will be presented as a JSON string. Utilizing the extended response extendedResponse(1) will be helpful when solving captchas such as ClickCaptcha.

Solve captcha

When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.

Captcha options

Option Default Value Description
numeric 0 Defines if captcha contains numeric or other symbols see more info in the API docs
minLength 0 minimal answer length
maxLength 0 maximum answer length
phrase 0 defines if the answer contains multiple words or not
caseSensitive 0 defines if the answer is case sensitive
calc 0 defines captcha requires calculation
lang - defines the captcha language, see the list of supported languages
hintImg - an image with hint shown to workers with the captcha
hintText - hint or task text shown to workers with the captcha

Below you can find basic examples for every captcha type. Check out examples directory to find more examples with all available options.

Basic example

Example below shows a basic solver call example with error handling.

Normal captcha = new Normal();
captcha.setFile("path/to/captcha.jpg");
captcha.setMinLen(4);
captcha.setMaxLen(20);
captcha.setCaseSensitive(true);
captcha.setLang("en");

try {
    solver.solve(captcha);
    System.out.println("Captcha solved: " + captcha.getCode());
} catch (Exception e) {
    System.out.println("Error occurred: " + e.getMessage());
}

Normal Captcha

API method description.

To bypass a normal captcha (distorted text on image) use the following method. This method also can be used to recognize any text on the image.

Normal captcha = new Normal();
captcha.setFile("path/to/captcha.jpg");
captcha.setNumeric(4);
captcha.setMinLen(4);
captcha.setMaxLen(20);
captcha.setPhrase(true);
captcha.setCaseSensitive(true);
captcha.setCalc(false);
captcha.setLang("en");
captcha.setHintImg(new File("path/to/hint.jpg"));
captcha.setHintText("Type red symbols only");

Text Captcha

API method description.

This method can be used to bypass a captcha that requires to answer a question provided in clear text.

Text captcha = new Text();
captcha.setText("If tomorrow is Saturday, what day is today?");
captcha.setLang("en");

reCAPTCHA v2

API method description.

Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection.

ReCaptcha captcha = new ReCaptcha();
captcha.setSiteKey("6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-");
captcha.setUrl("https://mysite.com/page/with/recaptcha");
captcha.setInvisible(true);
captcha.setEnterprise(true);
captcha.setAction("verify");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

reCAPTCHA v3

API method description.

This method provides reCAPTCHA V3 solver and returns a token.

ReCaptcha captcha = new ReCaptcha();
captcha.setSiteKey("6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-");
captcha.setUrl("https://mysite.com/page/with/recaptcha");
captcha.setVersion("v3");
captcha.setEnterprise(false);
captcha.setAction("verify");
captcha.setScore(0.3);
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

FunCaptcha

API method description.

FunCaptcha (Arkoselabs) solving method. Returns a token.

FunCaptcha captcha = new FunCaptcha();
captcha.setSiteKey("69A21A01-CC7B-B9C6-0F9A-E7FA06677FFC");
captcha.setUrl("https://mysite.com/page/with/funcaptcha");
captcha.setSUrl("https://client-api.arkoselabs.com");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36");
captcha.setData("anyKey", "anyValue");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

GeeTest

API method description.

Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.

GeeTest captcha = new GeeTest();
captcha.setGt("f2ae6cadcf7886856696502e1d55e00c");
captcha.setApiServer("api-na.geetest.com");
captcha.setChallenge("12345678abc90123d45678ef90123a456b");
captcha.setUrl("https://mysite.com/captcha.html");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

GeeTest v4

API method description.

Method to solve GeeTestV4 puzzle captcha. Returns a set of tokens as JSON.

GeeTestV4 captcha = new GeeTestV4();
captcha.setCaptchaId("72bf15796d0b69c43867452fea615052");
captcha.setApiServer("api-na.geetest.com");
captcha.setChallenge("12345678abc90123d45678ef90123a456b");
captcha.setUrl("https://mysite.com/captcha.html");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

KeyCaptcha

API method description.

Token-based method to solve KeyCaptcha.

KeyCaptcha captcha = new KeyCaptcha();
captcha.setUserId(10);
captcha.setSessionId("493e52c37c10c2bcdf4a00cbc9ccd1e8");
captcha.setWebServerSign("9006dc725760858e4c0715b835472f22");
captcha.setWebServerSign2("2ca3abe86d90c6142d5571db98af6714");
captcha.setUrl("https://www.keycaptcha.ru/demo-magnetic/");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

Capy

API method description.

Token-based method to bypass Capy puzzle captcha.

Capy captcha = new Capy();
captcha.setSiteKey("PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v");
captcha.setUrl("https://www.mysite.com/captcha/");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

Grid

API method description.

Grid method is originally called Old reCAPTCHA V2 method. The method can be used to bypass any type of captcha where you can apply a grid on image and need to click specific grid boxes. Returns numbers of boxes.

Grid captcha = new Grid();
captcha.setFile("path/to/captcha.jpg");
captcha.setRows(3);
captcha.setCols(3);
captcha.setPreviousId(0);
captcha.setCanSkip(false);
captcha.setLang("en");
captcha.setHintImg(new File("path/to/hint.jpg"));
captcha.setHintText("Select all images with an Orange");

Canvas

API method description.

Canvas method can be used when you need to draw a line around an object on image. Returns a set of points' coordinates to draw a polygon.

Canvas captcha = new Canvas();
captcha.setFile("path/to/captcha.jpg");
captcha.setPreviousId(0);
captcha.setCanSkip(false);
captcha.setLang("en");
captcha.setHintImg(new File("path/to/hint.jpg"));
captcha.setHintText("Draw around apple");

ClickCaptcha

API method description.

ClickCaptcha method returns coordinates of points on captcha image. Can be used if you need to click on particular points on the image.

Coordinates captcha = new Coordinates();
captcha.setFile("path/to/captcha.jpg");
captcha.setLang("en");
captcha.setHintImg(new File("path/to/hint.jpg"));
captcha.setHintText("Select all images with an Orange");

Rotate

API method description.

This method can be used to solve a captcha that asks to rotate an object. Mostly used to bypass FunCaptcha. Returns the rotation angle.

Rotate captcha = new Rotate();
captcha.setFile("path/to/captcha.jpg");
captcha.setAngle(40);
captcha.setLang("en");
captcha.setHintImg(new File("path/to/hint.jpg"));
captcha.setHintText("Put the images in the correct way up");

Audio Captcha

API method description.

Use the following method to bypass an audio captcha (mp3 formats only). You must provide the language as lang = 'en'. Supported languages are "en", "ru", "de", "el", "pt", "fr".

TwoCaptcha solver = new TwoCaptcha(args[0]);
byte[] bytes = Files.readAllBytes(Paths.get("src/main/resources/audio-en.mp3"));
String base64EncodedImage = Base64.getEncoder().encodeToString(bytes);
Audio captcha = new Audio();
captcha.setBase64(base64EncodedImage);

Yandex

Use this method to solve Yandex and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
Yandex captcha = new Yandex();
captcha.setSiteKey("Y5Lh0tiycconMJGsFd3EbbuNKSp1yaZESUOIHfeV");
captcha.setUrl("https://rutube.ru");

Lemin Cropped Captcha

API method description.

Use this method to solve Lemin and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
Lemin captcha = new Lemin();      
captcha.setCaptchaId("CROPPED_d3d4d56_73ca4008925b4f83a8bed59c2dd0df6d");
captcha.setUrl("https://mysite.com/page/with/LeminCaptcha");
captcha.setApiServer("api.leminnow.com");

Cloudflare Turnstile

API method description.

Use this method to solve Cloudflare Turnstile and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
Turnstile captcha = new Turnstile();
captcha.setSiteKey("0x4AAAAAAAChNiVJM_WtShFf");
captcha.setUrl("https://ace.fusionist.io");

Amazon WAF

API method description.

Use this method to solve Amazon WAF and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
AmazonWaf captcha = new AmazonWaf();
captcha.setSiteKey("AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AF5H1K/siwSLK7RfstKtN5bAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglg");
captcha.setUrl("https://non-existent-example.execute-api.us-east-1.amazonaws.com");
captcha.setIV("test_iv");
captcha.setContext("test_context");

Friendly Captcha

API method description.

Use this method to solve Friendly Captcha and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
FriendlyCaptcha friendlyCaptcha = new FriendlyCaptcha();
friendlyCaptcha.setSiteKey("FCMST5VUMCBOCGQ9");
friendlyCaptcha.setPageUrl("https://mysite.com/page/with/FriendlyCaptcha");

MTCaptcha

API method description.

Use this method to solve MTCaptcha and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
MtCaptcha mtCaptcha = new MtCaptcha();
mtCaptcha.setSiteKey("MTPublic-KzqLY1cKH");
mtCaptcha.setPageUrl("https://2captcha.com/demo/mtcaptcha");

Tencent

API method description.

Use this method to solve Tencent and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
Tencent tencent = new Tencent();
tencent.setAppId("2092215077");
tencent.setPageUrl("https://mysite.com/page/with/tencent");

Cutcaptcha

API method description.

Use this method to solve Cutcaptcha and obtain a token to bypass the protection.

TwoCaptcha solver = new TwoCaptcha(args[0]);
Cutcaptcha cutcaptcha = new Cutcaptcha();
cutcaptcha.setMiseryKey("a1488b66da00bf332a1488993a5443c79047e752");
cutcaptcha.setUrl("https://filecrypt.co/Container/237D4D0995.html");
cutcaptcha.setDataApiKey("SAb83IIB");

atbCAPTCHA

API method description.

Use this method to solve atbCAPTCHA and obtain a token to bypass the protection.

AtbCAPTCHA captcha = new AtbCAPTCHA();
captcha.setAppId("af23e041b22d000a11e22a230fa8991c");
captcha.setPageUrl("https://www.playzone.vip/");
captcha.setApiServer("https://cap.aisecurius.com");

CyberSiARA

API method description.

Use this method to solve CyberSiARA and obtain a token to bypass the protection.

Cybersiara captcha = new Cybersiara();
captcha.setMasterUrlId("tpjOCKjjpdzv3d8Ub2E9COEWKt1vl1Mv");
captcha.setUrl("https://demo.mycybersiara.com/");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36");

DataDome

API method description.

Use this method to solve DataDome and obtain a token to bypass the protection.

Important

To solve the DataDome captcha, you must use a proxy. It is recommended to use residential proxies.

DataDome captcha = new DataDome();
captcha.setCaptchaUrl("https://geo.captcha-delivery.com/captcha/?initialCid=AHrlqAAA...P~XFrBVptk&t=fe&referer=https%3A%2F%2Fhexample.com&s=45239&e=c538be..c510a00ea");
captcha.setUrl("https://example.com/");
captcha.setUserAgent("Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Mobile Safari/537.3");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

Other methods

send / getResult

These methods can be used for manual captcha submission and answer polling.

String captchaId = solver.send(captcha);

Thread.sleep(20 * 1000);

String code = solver.getResult(captchaId);

balance

API method description.

Use this method to get your account's balance

double balance = solver.balance();

report

API method description.

Use this method to report good or bad captcha answer.

solver.report(captcha.getId(), true); // captcha solved correctly
solver.report(captcha.getId(), false); // captcha solved incorrectly

Proxies

You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, keycaptcha, capy puzzle, lemin, turnstile, amazon waf and etc. The proxy will be forwarded to the API to solve the captcha.

We have our own proxies that we can offer you. Buy residential proxies for avoid restrictions and blocks. Quick start.

captcha.setProxy("HTTPS", "login:password@IP_address:PORT");

Error handling

If case of an error captcha solver throws an exception. It's important to properly handle these cases. We recommend to use try catch to handle exceptions. The list of all errors can be found in the API documentation.

try {
    solver.solve(captcha);
} catch (ValidationException e) {
    // invalid parameters passed
} catch (NetworkException e) {
    // network error occurred
} catch (ApiException e) {
    // api respond with error
} catch (TimeoutException e) {
    // captcha is not solved so far
}

Examples

Examples of solving all supported captcha types are located in the examples directory.

Get in touch

Join the team 👪

There are many ways to contribute, of which development is only one! Find your next job. Open positions: AI experts, scrapers, developers, technical support, and much more! 😍

License

The code in this repository is licensed under the MIT License. See the LICENSE file for more details.

Graphics and Trademarks

The graphics and trademarks included in this repository are not covered by the MIT License. Please contact support for permissions regarding the use of these materials.