Skip to content

Commit a99ad07

Browse files
dzmitry-duboyskidzmitry-duboyski
committed
update readme.md En
1 parent 8d8dff4 commit a99ad07

File tree

1 file changed

+154
-39
lines changed

1 file changed

+154
-39
lines changed

‎README.md‎

Lines changed: 154 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<img src="https://user-images.githubusercontent.com/38065632/280106746-36b3ccc1-b720-458d-9887-88d87b7dd66e.jpg">
44
</p>
55

6+
![](https://img.shields.io/npm/dt/2captcha-ts?color=00bd79)
67
![](https://img.shields.io/npm/v/2captcha-ts)
78
![](https://img.shields.io/npm/l/2captcha-ts)
89
![](https://img.shields.io/github/last-commit/dzmitry-duboyski/2captcha-ts)
@@ -26,25 +27,32 @@ Also added support for the `bounding_box` method. The Bounding Box Method allows
2627
- Proxy Support
2728

2829
## Supported captchas:
29-
- ✅ google-recaptcha (reCAPTCHA v2 / reCAPTCHA v3)
30-
- ✅ hCaptcha
31-
- ✅ Arkose Labs FunCaptcha
32-
- ✅ Image captchas. (`base64` format)
33-
- ✅ Geetest
34-
- ✅ Geetest v4
35-
- ✅ Yandex Smart Captcha
36-
- ✅ Lemin Cropped Captcha
37-
- ✅ Cloudflare Turnstile
38-
- ✅ Amazon WAF Captcha
39-
- ✅ Capy Puzzle
40-
- ✅ Сoordinates (Click Captcha)
30+
- ✅ google-recaptcha ([reCAPTCHA v2](#recaptcha-v2) / [reCAPTCHA v3](#recaptcha-v3))
31+
- ✅ [hCaptcha](#hCaptcha)
32+
- ✅ [Arkose Labs FunCaptcha](#arkose-labs-funcaptcha)
33+
- ✅ [Image captchas](#image-captcha) (`base64` format)
34+
- ✅ [GeeTest](#geetest-captcha)
35+
- ✅ [GeeTest V4](#geetest-v4-captcha)
36+
- ✅ [Yandex Smart Captcha](#yandex-smart-captcha)
37+
- ✅ [Lemin Cropped Captcha](#lemin-captcha)
38+
- ✅ [Cloudflare Turnstile](#cloudflare-turnstile)
39+
- ✅ [Amazon WAF Captcha](#amazon-waf-captcha)
40+
- ✅ [Capy Puzzle](#capy-puzzle)
41+
- ✅ [Сoordinates (Click Captcha)](#coordinates-captcha)
4142
- ⬜ Audio Recogntion
42-
- ✅ DataDome CAPTCHA
43-
- ✅ СyberSiARA
44-
- ✅ MTCaptcha
45-
- ✅ Bounding Box Method
43+
- ✅ [DataDome CAPTCHA](#datadome-captcha)
44+
- ✅ [CyberSiARA](#cybersiara)
45+
- ✅ [MTCaptcha](#mtcaptcha)
46+
- ✅ [Bounding Box Method](#bounding-box-method)
4647
<!-- ⬜ -->
4748

49+
## Other methods:
50+
- [Proxy](#proxy)
51+
- [badReport](#badreport)
52+
- [goodReport](#goodreport)
53+
- [balance](#balance)
54+
55+
4856
## Install
4957

5058
```sh
@@ -56,8 +64,12 @@ yarn add 2captcha-ts
5664

5765
## Usage
5866

67+
### reCAPTCHA V2
68+
69+
Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
70+
71+
Code example:
5972

60-
### reCAPTCHA:
6173
```js
6274
const Captcha = require("2captcha-ts")
6375
// A new 'solver' instance with your API key
@@ -76,7 +88,38 @@ solver.recaptcha({
7688
})
7789
```
7890

79-
### hCaptcha:
91+
### reCAPTCHA V3
92+
93+
This method provides ReCaptcha V3 solver and returns a token.
94+
95+
Code example:
96+
97+
```js
98+
const Captcha = require("2captcha-ts")
99+
const solver = new Captcha.Solver("<Your 2captcha api key>")
100+
101+
solver.recaptcha({
102+
pageurl: 'https://2captcha.com/demo/recaptcha-v3',
103+
googlekey: '6Lcyqq8oAAAAAJE7eVJ3aZp_hnJcI6LgGdYD8lge',
104+
version: "v3",
105+
min_score: "0.4",
106+
action: 'demo_action'
107+
})
108+
.then((res) => {
109+
console.log(res);
110+
})
111+
.catch((err) => {
112+
console.log(err);
113+
})
114+
```
115+
116+
117+
### hCaptcha
118+
119+
Use this method to solve hCaptcha challenge. Returns a token to bypass captcha.
120+
121+
Code example:
122+
80123
```js
81124
const Captcha = require("2captcha-ts")
82125
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -93,7 +136,12 @@ solver.hcaptcha({
93136
})
94137
```
95138

96-
### Arkose Labs FunCaptcha:
139+
### Arkose Labs FunCaptcha
140+
141+
FunCaptcha (Arkoselabs) solving method. Returns a token.
142+
143+
Code example:
144+
97145
```js
98146
const Captcha = require("2captcha-ts")
99147
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -110,7 +158,12 @@ solver.funCaptcha({
110158
})
111159
```
112160

113-
### Image captcha:
161+
### Image captcha
162+
163+
To bypass a normal captcha (distorted text on image) use this method. This method also can be used to recognize any text on the image.
164+
165+
Code example:
166+
114167
```js
115168
const Captcha = require("2captcha-ts")
116169
const fs = require("fs")
@@ -135,7 +188,12 @@ solver.imageCaptcha({
135188
```
136189

137190

138-
### GeeTest Captcha:
191+
### GeeTest Captcha
192+
193+
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
194+
195+
Code example:
196+
139197
```js
140198
const Captcha = require("2captcha-ts")
141199
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -154,7 +212,12 @@ solver.geetest({
154212
})
155213
```
156214

157-
### GeeTest V4 Captcha:
215+
### GeeTest V4 Captcha
216+
217+
Method to solve GeeTest V4 puzzle captcha. Returns a set of tokens as JSON.
218+
219+
Code example:
220+
158221
```js
159222
const Captcha = require("2captcha-ts")
160223
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -171,7 +234,12 @@ solver.geetestV4({
171234
})
172235
```
173236

174-
### Yandex Smart Captcha:
237+
### Yandex Smart Captcha
238+
239+
Use this method to solve Yandex and obtain a token to bypass the protection.
240+
241+
Code example:
242+
175243
```js
176244
const Captcha = require("2captcha-ts")
177245
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -188,7 +256,12 @@ solver.yandexSmart({
188256
})
189257
```
190258

191-
### Lemin captcha:
259+
### Lemin captcha
260+
261+
Use this method to solve Lemin and obtain a token to bypass the protection.
262+
263+
Code example:
264+
192265
```js
193266
const Captcha = require("2captcha-ts")
194267
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -207,7 +280,12 @@ solver.lemin({
207280
})
208281
```
209282

210-
### Cloudflare Turnstile:
283+
### Cloudflare Turnstile
284+
285+
Use this method to solve Turnstile and obtain a token to bypass the protection.
286+
287+
Code example:
288+
211289
```js
212290
const Captcha = require("2captcha-ts")
213291
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -224,7 +302,12 @@ solver.cloudflareTurnstile({
224302
})
225303
```
226304

227-
### Amazon WAF Captcha (AWS WAF):
305+
<h3 id="amazon-waf-captcha">Amazon WAF Captcha (AWS WAF):</h3>
306+
307+
Use this method to solve AmazonWaf and obtain a token to bypass the protection.
308+
309+
Code example:
310+
228311
```js
229312
const Captcha = require("2captcha-ts")
230313
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -245,6 +328,11 @@ solver.amazonWaf({
245328
```
246329

247330
### Capy Puzzle
331+
332+
Token-based method to bypass Capy puzzle captcha.
333+
334+
Code example:
335+
248336
```js
249337
const Captcha = require("2captcha-ts")
250338
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -262,6 +350,14 @@ solver.capyPuzzle({
262350
```
263351

264352
### DataDome CAPTCHA
353+
354+
Use this method to solve DataDome and obtain a token to bypass the protection.
355+
356+
> [!IMPORTANT]
357+
> To solve the DataDome captcha, you must use a proxy. It is recommended to use mobile residential proxies.
358+
359+
Code example:
360+
265361
```js
266362
const Captcha = require("2captcha-ts")
267363
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -282,7 +378,12 @@ console.log(err);
282378
})
283379
```
284380

285-
### СyberSiARA
381+
### CyberSiARA
382+
383+
Use this method to solve CyberSiARA and obtain a token to bypass the protection.
384+
385+
Code example:
386+
286387
```js
287388
const Captcha = require("2captcha-ts")
288389
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -302,6 +403,11 @@ console.log(err);
302403
```
303404

304405
### MTCaptcha
406+
407+
Use this method to solve MTCaptcha and obtain a token to bypass the protection.
408+
409+
Code example:
410+
305411
```js
306412
const Captcha = require("2captcha-ts")
307413
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -319,7 +425,12 @@ console.log(err);
319425
})
320426
```
321427

322-
### Сoordinates (Click Captcha):
428+
<h3 id="coordinates-captcha">Сoordinates (Click Captcha):</h3>
429+
430+
ClickCaptcha method returns coordinates of points on captcha image. Can be used if you need to click on particular points on the image.
431+
432+
Code example:
433+
323434
```js
324435
const Captcha = require("2captcha-ts")
325436
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -338,7 +449,11 @@ solver.coordinates({
338449
```
339450

340451
### Bounding Box Method:
452+
341453
Bounding Box Method allows you to select objects specified in the image. To do this, you need to pass markup instructions. The instructions can be sent as text or as an image encoded in base64 format. It is mandatory to pass at least one instruction `imginstructions` or `textinstructions`.
454+
455+
Code example:
456+
342457
```js
343458
const Captcha = require("2captcha-ts")
344459
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -355,7 +470,10 @@ solver.boundingBox({
355470
})
356471
```
357472

358-
### Proxy:
473+
### Proxy
474+
475+
Solving reCAPTCHA V2 whis a proxy, code example:
476+
359477
```js
360478
const Captcha = require("2captcha-ts")
361479
const solver = new Captcha.Solver("<Your 2captcha api key>")
@@ -364,7 +482,7 @@ solver.recaptcha({
364482
pageurl: 'https://2captcha.com/demo/recaptcha-v2',
365483
googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
366484
proxy: "login:password@1.2.3.4:8888", // The (Username : Password @ Address : Port) of our chosen proxy
367-
proxytype: "http" // The 'Type' of proxy, http, https, socks, ect.
485+
proxytype: "http" // The 'Type' of proxy, http, https, socks4, socks5.
368486
})
369487
.then((res) => {
370488
console.log(res)
@@ -374,15 +492,13 @@ solver.recaptcha({
374492
})
375493
```
376494

377-
<!-- ## Commit Guidelines
495+
## Other methods
378496

379-
The latest version of the code base will always be under the '**next**' branch!
497+
### goodReport
498+
### badReport
499+
### balance
380500

381-
- All pull requiests must provide a valid reason for the change or implementation
382-
- All **CORE CHANGES** require an issue with reasoning made before a PR will even be addressed.
383-
- All PR's must follow the general structure of the code base
384-
- If you have questions, feel free to make an issue and i'll get to it right away!
385-
-->
501+
Use this method to get your account's balance
386502

387503
## Useful articles
388504
* [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support)
@@ -394,6 +510,5 @@ The latest version of the code base will always be under the '**next**' branch!
394510
* [Solving reCAPTCHA using Puppeteer](https://github.com/dzmitry-duboyski/solving-recaptcha-using-puppeteer)
395511
* [Solving Yandex Smart Captcha using Puppeteer](https://github.com/dzmitry-duboyski/solving-yandex-smart-captcha-using-puppeteer)
396512

397-
---
398513

399-
This project is a fork of this [package](https://www.npmjs.com/package/2captcha). In this version, new types of captchas have been added and the method of passing captcha parameters has been changed ({ using an object }) and etc. You can read more about the changes made [here](https://github.com/dzmitry-duboyski/2captcha-ts/releases).
514+
<!-- This project is a fork of this [package](https://www.npmjs.com/package/2captcha). In this version, new types of captchas have been added and the method of passing captcha parameters has been changed ({ using an object }) and etc. You can read more about the changes made [here](https://github.com/dzmitry-duboyski/2captcha-ts/releases). -->

0 commit comments

Comments
 (0)