2captcha-java

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 55 Open GitHub ↗

Java library for easy integration with the API of 2captcha captcha solving service to bypass recaptcha, funcaptcha, geetest and solve any other captchas.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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.

- [JAVA Module for 2Captcha API (captcha solver)](#java-module-for-2captcha-api-captcha-solver)
  - [Installation](#installation)
  - [Configuration](#configuration)
    - [TwoCaptcha instance options](#twocaptcha-instance-options)
  - [Solve captcha](#solve-captcha)
    - [Captcha options](#captcha-options)
    - [Basic example](#basic-example)
    - [Normal Captcha](#normal-captcha)
    - [Text Captcha](#text-captcha)
    - [reCAPTCHA v2](#recaptcha-v2)
    - [reCAPTCHA v3](#recaptcha-v3)
    - [FunCaptcha](#funcaptcha)
    - [GeeTest](#geetest)
    - [GeeTest v4](#geetest-v4)
    - [KeyCaptcha](#keycaptcha)
    - [Capy](#capy)
    - [Grid](#grid)
    - [Canvas](#canvas)
    - [ClickCaptcha](#clickcaptcha)
    - [Rotate](#rotate)
    - [Audio Captcha](#audio-captcha)
    - [Yandex](#yandex)
    - [Lemin Cropped Captcha](#lemin-cropped-captcha)
    - [Cloudflare Turnstile](#cloudflare-turnstile)
    - [Amazon WAF](#amazon-waf)
    - [Friendly Captcha](#friendly-captcha)
    - [MTCaptcha](#mtcaptcha)
    - [Tencent](#tencent)
    - [Cutcaptcha](#cutcaptcha)
    - [atbCAPTCHA](#atbcaptcha)
    - [CyberSiARA](#cybersiara)
    - [DataDome](#datadome)
    - [CaptchaFox](#captchafox)
    - [Temu](#temu)
    - [Prosopo](#prosopo)
    - [VK Captcha](#vk-captcha)
    - [VK Image](#vk-image)
    - [Altchacaptcha](#altchacaptcha)
    - [Binancecaptcha](#binancecaptcha)
    - [Yidun](#yidun)
    - [Basilisk](#basilisk)
    - [Alibaba](#alibaba)
    - [TSPD](#tspd)
    - [Hunt](#hunt)
  - [Other methods](#other-methods)
    - [send / getResult](#send--getresult)
    - [balance](#balance)
    - [report](#report)
  - [Proxies](#proxies)
  - [Error handling](#error-handling)
  - [Examples](#examples)
- [Get in touch](#get-in-touch)
- [Join the team 👪](#join-the-team-)
- [License](#license)
  - [Graphics and Trademarks](#graphics-and-trademarks)

## Installation
2captcha-java artifact is available in [Maven Central]

## Configuration
`TwoCaptcha` instance can be created like this:
```java
TwoCaptcha solver = new TwoCaptcha('YOUR_API_KEY');
```
Also there are few options that can be configured:
```java
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](#clickcaptcha), [Canvas](#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](#send--getresult)

> [!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](#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][post options] |
| 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.

```java
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.](https://2captcha.com/2captcha-api#solving_normal_captcha)

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.

```java
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.](https://2captcha.com/2captcha-api#solving_text_captcha)

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

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

### reCAPTCHA v2

[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav2_new)

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

```java
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");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36");
captcha.setCookies("KEY1:Value1;KEY2:Value2;");
```
### reCAPTCHA v3

[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav3)

This method provides reCAPTCHA V3 solver and returns a token.

### FunCaptcha

[API method description.](https://2captcha.com/2captcha-api#solving_funcaptcha_new)

FunCaptcha (Arkoselabs) solving method. Returns a token.

```java
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.](https://2captcha.com/2captcha-api#solving_geetest)

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

```java
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.](https://2captcha.com/2captcha-api#geetest-v4)

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

```java
GeeTestV4 captcha = new GeeTestV4();
captcha.setCaptchaId("72bf15796d0b69c43867452fea615052");
captcha.setApiServer("api-na.geetest.com");
captcha.setChallenge("12345678abc90123d45678ef90123a456b");
captcha.setUrl("https://mysite.com/captcha.html");
captcha.setRiskType("slide|1779887038.402245|6563f67750ef47d9b1302ef524gf719f|04fe1ca6a68510c08f6f9aacfe4ce284a9e672d9ecb4212e6cd593ad583ef054");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");
```

### KeyCaptcha

[API method description.](https://2captcha.com/2captcha-api#solving_keycaptcha)

Token-based method to solve KeyCaptcha.

```java
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.](https://2captcha.com/2captcha-api#solving_capy)

Token-based method to bypass Capy puzzle captcha.

```java
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.](https://2captcha.com/2captcha-api#grid)

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.

```java
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.](https://2captcha.com/2captcha-api#canvas)

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.

```java
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.](https://2captcha.com/2captcha-api#coordinates)

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

```java
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.](https://2captcha.com/2captcha-api#solving_rotatecaptcha)

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

```java
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.](https://2captcha.com/2captcha-api#audio)

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".

```java
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.

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

### Lemin Cropped Captcha

[API method description.](https://2captcha.com/2captcha-api#lemin)

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

```java
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.](https://2captcha.com/2captcha-api#turnstile)

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

```java
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.](https://2captcha.com/2captcha-api#amazon-waf)

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

```java
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.](https://2captcha.com/2captcha-api#friendly-captcha)

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

```java
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.](https://2captcha.com/2captcha-api#mtcaptcha)

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

```java
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.](https://2captcha.com/2captcha-api#tencent)

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

```java
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.](https://2captcha.com/2captcha-api#cutcaptcha)

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

```java
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.](https://2captcha.com/2captcha-api#atb-captcha)

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

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

### CyberSiARA

[API method description.](https://2captcha.com/2captcha-api#cybersiara)

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

```java
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.](https://2captcha.com/2captcha-api#datadome)

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].

```java
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");
```

### CaptchaFox

[API method description.](https://2captcha.com/2captcha-api#captchafox)

This method can be used to solve CaptchaFox using a token. Returns a token.

```java
Captchafox captcha = new Captchafox();
captcha.setSiteKey("sk_ILKWNruBBVKDOM7dZs59KHnDLEWiH");
captcha.setUrl("https://mysite.com/page/with/captchafox");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36");
captcha.setApiServer("https://mam.example.com");
```

### Temu

[API method description.](https://2captcha.com/2captcha-api#temucaptcha)

This method can be used to solve Temu. Returns a coordinates.

```java
Temu captcha = new Temu();
captcha.setBody(body);
captcha.setPart1(part1);
captcha.setPart2(part2);
captcha.setPart3(part3);
```

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

```java
TwoCaptcha solver = new TwoCaptcha(args[0]);   // args[0] = "API KEY"
Prosopo captcha = new Prosopo();
captcha.setSiteKey("5EZVvsHMrKCFKp5NYNoTyDjTjetoVo1Z4UNNbTwJf1GfN6Xm");
captcha.setUrl("https://www.twickets.live/");
```

### VK Image

[API method description.](https://2captcha.com/2captcha-api#vkcaptcha)

We offer two methods to solve this type of captcha - token-based and image-based.

We use the body (image in base64 format) or file (image as file) and steps parameters.
You can get both values from the response to the request https://api.vk.com/method/captchaNotRobot.getContent?v={API_VER} when loading the captcha widget on the page.

```java
VkCaptcha captcha = new VkCaptcha("vkimage");
captcha.setImageBase64(base64EncodedImage);
captcha.setSteps("[5,12,22,24,21,23,10,7,2,8,...]");
```

### VK Captcha

[API method description.](https://2captcha.com/2captcha-api#vk-captcha)

Token-based method requires redirect_uri parameter, as well as proxy and userAgent. The value of the redirect_uri parameter can be found in the response to requests to the VK API that return captchas.

```java
VkCaptcha captcha = new VkCaptcha("vkcaptcha");
captcha.setRedirectUri("https://id.vk.com/not_robot_captcha?domain=vk.com&session_token=eyJ....HGsc5B4LyvjA&variant=popup&blank=1");
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");
captcha.setProxy("http", "1.2.3.4");
```

### Altchacaptcha

[API method description.](https://2captcha.com/2captcha-api#altchacaptcha)

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

```java
Altchacaptcha captcha = new Altchacaptcha();
captcha.setChallengeUrl("https://.../captcha/api/altcha/challenge");
captcha.setPageUrl("https://site.com/");
```

### Binancecaptcha

[API method description.](https://2captcha.com/ru/2captcha-api#binance)

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

```java
BinanceCaptcha captcha = new BinanceCaptcha();
captcha.setSiteKey("login");
captcha.setPageUrl("https://example.com/page-with-binance");
captcha.setValidateId("cb0bfef...e54ecd57b");
```

### Yidun

[API method description.](https://2captcha.com/ru/2captcha-api#yidun)

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

```java
Yidun captcha = new Yidun();
captcha.setSiteKey("0f743r3g1...8rz3grz0ym5");
captcha.setPageUrl("https://example.com/page-with-yidun");
```

### Alibaba

[API method description.](https://2captcha.com/2captcha-api#alibaba)

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

```java
AlibabaCaptcha captcha = new AlibabaCaptcha();
captcha.setSceneId("login");
captcha.setPrefix("https://img.alicdn.com/tfs/...");
captcha.setPageUrl("https://example.com/page-with-alibaba");
```

### Basilisk

[API method description.](https://2captcha.com/ru/2captcha-api#basilisk)

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

```java
Basilisk captcha = new Basilisk();
captcha.setSiteKey("b7890h...19fb2600897");
captcha.setUrl("https://example.com/page-with-basilisk");
```

### Tspd

[API method description.](https://2captcha.com/ru/2captcha-api#tspd)

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

```java
Tspd captcha = new Tspd();
captcha.setPageUrl("https://example.com/page-with-tspd");
captcha.setTspdCookie("TS386a400d029=...");
captcha.setHtmlPageBase64("PCFET0NUWVBFIGh0bWw+...");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");
```

### Hunt

[API method description.](https://2captcha.com/ru/2captcha-api#hunt)

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

```java
Hunt captcha = new Hunt();
captcha.setPageUrl("https://example.com/page-with-hunt");
captcha.setApiGetLib("https://example.com/api.js");
captcha.setData("meta.token.value");
captcha.setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36");
captcha.setProxy("HTTPS", "login:password@IP_address:PORT");
```

## Other methods

### send / getResult
These methods can be used for manual captcha submission and answer polling.

```java
String captchaId = solver.send(captcha);

Thread.sleep(20 * 1000);

String code = solver.getResult(captchaId);
```
### balance

[API method description.](https://2captcha.com/2captcha-api#additional-methods)

Use this method to get your account's balance

```java
double balance = solver.balance();
```
### report

[API method description.](https://2captcha.com/2captcha-api#complain)

Use this method to report good or bad captcha answer.

```java
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](https://2captcha.com/proxy/residential-proxies) for avoid restrictions and blocks. [Quick start](https://2captcha.com/proxy?openAddTrafficModal=true).

```java
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](https://2captcha.com/2captcha-api#list-of-inphp-errors).

```java
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](./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 <a href="mailto:support@2captcha.com">support</a> for permissions regarding the use of these materials.

[Maven Central]: https://search.maven.org/artifact/com.github.2captcha/2captcha-java
[Examples directory]: ./src/main/java/examples
[examples]: ./src/main/java/examples
[2Captcha]: https://2captcha.com/
[2captcha software catalog]: https://2captcha.com/software
[Pingback settings]: https://2captcha.com/setting/pingback
[Post options]: https://2captcha.com/2captcha-api#normal_post
[List of supported languages]: https://2captcha.com/2captcha-api#language
[Java captcha solver]: https://2captcha.com/lang/java
[residential proxies]: https://2captcha.com/proxy/residential-proxies

2captcha-java

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README