@2captcha/captcha-solver 1.0.0 → 1.0.2

package/README.md

@@ -1,14 +1,11 @@
-<b>[English](README.md)</b> (recommended) | [中国语文科](README.zh.md) | [Русский](README.ru.md)
-
-
-# JavaScript Module for 2Captcha API
+# JavaScript captcha solver module for 2Captcha API
 
 ## Description
-A wrapper around the [2captcha](https://2captcha.com/) API. This wrapper support reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Coordinates (Click Captcha), Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile, Capy Puzzle, DataDome CAPTCHA, CyberSiARA, MTCaptcha, Friendly Captcha. 
+A wrapper around the [2captcha](https://2captcha.com/) API. This wrapper supports any captcha bypass: reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Coordinates (Click Captcha), Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile, Capy Puzzle, DataDome CAPTCHA, CyberSiARA, MTCaptcha, Friendly Captcha. 
 
 Also added support for the `bounding_box` method. The Bounding Box Method allows you to mark data on the image. This method can be used to mark up datasets or highlight any objects in an image according to the given instructions. Read more about using *Bounding Box Method* on [documentation](https://2captcha.com/2captcha-api#bounding_box).
 
-[2captcha](https://2captcha.com/) is a service that solves many different types of captchas, this library serves as a wrapper around API 2captcha to bring easy, promise-based functionality to NodeJS. This library specializes in concurrent solves, and bulk-api usage.
+[2captcha](https://2captcha.com/) is a service that solves many different types of captchas, this library serves as a wrapper around API 2captcha to bring easy, promise-based functionality to Node.js. This library specializes in concurrent solves, and Bulk API usage.
 
 - [Install](#install)
 - [Configuration](#configuration)
@@ -36,6 +33,7 @@ Also added support for the `bounding_box` method. The Bounding Box Method allows
   - [badReport](#badreport)
   - [goodReport](#goodreport)
   - [balance](#balance)
+- [Proxies](#proxies)
 - [Useful articles](#useful-articles)
   - [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support)
   - [Automatic reCAPTCHA V3 resolution - a tutorial for developers and customers](https://2captcha.com/blog/recaptcha-v3-automatic-resolution)
@@ -197,7 +195,7 @@ solver.geetestV4({
 
 ### Yandex Smart Captcha
 
-Use this method to solve Yandex and obtain a token to bypass the protection.
+Use this method to solve Yandex Smart Captcha and obtain a token to bypass the protection.
 
 ```js
 solver.yandexSmart({ 
@@ -214,7 +212,7 @@ solver.yandexSmart({
 
 ### Lemin captcha
 
-Use this method to solve Lemin and obtain a token to bypass the protection.
+Use this method to solve Lemin captcha and obtain a token to bypass the protection.
 
 ```js
 solver.lemin({
@@ -445,7 +443,28 @@ solver.balance()
 })
 ```
 
+## Proxies
+
+You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, keycaptcha, capy puzzle, lemin, turnstile, amazon waf, DataDome, CyberSiARA, MTCaptcha, Friendly Captcha 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].
+
+Solving reCAPTCHA V2 using proxy:
+```js
+solver.recaptcha({
+    pageurl: 'https://2captcha.com/demo/recaptcha-v2',
+    googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
+    proxy: 'HTTPS',
+    proxytype: 'login:password@123.123.123.123:3128'
+})
+```
+
+
 ## Useful articles
 * [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support)
 * [Automatic reCAPTCHA V3 resolution - a tutorial for developers and customers](https://2captcha.com/blog/recaptcha-v3-automatic-resolution)
-* Finding Sitekey <a href="./docs/hcaptcha.md">hCaptcha</a>
+* Finding Sitekey <a href="./docs/hcaptcha.md">hCaptcha</a>
+
+<!-- Shared links -->
+[Buy residential proxies]: https://2captcha.com/proxy/residential-proxies
+[Quick start]: https://2captcha.com/proxy?openAddTrafficModal=true

package/package.json

@@ -1,64 +1,64 @@
-{
-  "name": "@2captcha/captcha-solver",
-  "version": "1.0.0",
-  "description": "JavaScript library for easy integration with the API of 2captcha captcha solving service to bypass reCAPTCHA, hCaptcha, funcaptcha, geetest and solve any other captchas.",
-  "main": "dist/index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/2captcha/2captcha-javascript.git"
-  },
-  "license": "MIT",
-  "author": "2Captcha",
-  "bugs": {
-    "url": "https://github.com/2captcha/2captcha-javascript/issues"
-  },
-  "homepage": "https://github.com/2captcha/2captcha-javascript",
-  "types": "dist/index.d.ts",
-  "keywords": [
-    "2captcha",
-    "captcha",
-    "api",
-    "captchasolver",
-    "capmonster",
-    "reCAPTCHA",
-    "hCaptcha",
-    "FunCaptcha",
-    "Geetest",
-    "image captcha",
-    "Сoordinates",
-    "Click Captcha",
-    "Geetest V4",
-    "Yandex Smart Captcha",
-    "Lemin captcha",
-    "bypass captcha",
-    "solve captcha",
-    "Amazon WAF",
-    "Cloudflare Turnstile",
-    "Capy Puzzle",
-    "行为验证4.0",
-    "行为验证",
-    "DataDome CAPTCHA",
-    "CyberSiARA",
-    "MTCaptcha",
-    "Bounding Box Method",
-    "Friendly Captcha"
-  ],
-  "scripts": {
-    "go": "tsc && node ./dist/index.js",
-    "dev": "tsc && node ./issues/dev",
-    "jsdoc": "jsdoc",
-    "docgen": "tsc && yarn jsdoc ./dist -R \"./readme.md\" -P \"./package.json\" -t \"./node_modules/jaguarjs-jsdoc\" -d \"./docs\" -r",
-    "test": "tsc && node ./tests/mtCaptcha.js"
-  },
-  "dependencies": {
-    "node-fetch": "^2.6.1"
-  },
-  "devDependencies": {
-    "@types/node": "^20.8.7",
-    "@types/node-fetch": "^2.5.7",
-    "dotenv": "^16.0.3",
-    "jaguarjs-jsdoc": "^1.0.2",
-    "jsdoc": "^4.0.2",
-    "typescript": "^4.9.4"
-  }
-}
+{
+  "name": "@2captcha/captcha-solver",
+  "version": "1.0.2",
+  "description": "JavaScript library for easy integration with the API of 2captcha captcha solving service to bypass reCAPTCHA, hCaptcha, funcaptcha, geetest and solve any other captchas.",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/2captcha/2captcha-javascript.git"
+  },
+  "license": "MIT",
+  "author": "2Captcha",
+  "bugs": {
+    "url": "https://github.com/2captcha/2captcha-javascript/issues"
+  },
+  "homepage": "https://github.com/2captcha/2captcha-javascript",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "2captcha",
+    "captcha",
+    "api",
+    "captchasolver",
+    "capmonster",
+    "reCAPTCHA",
+    "hCaptcha",
+    "FunCaptcha",
+    "Geetest",
+    "image captcha",
+    "Coordinates",
+    "Click Captcha",
+    "Geetest V4",
+    "Yandex Smart Captcha",
+    "Lemin captcha",
+    "bypass captcha",
+    "solve captcha",
+    "Amazon WAF",
+    "Cloudflare Turnstile",
+    "Capy Puzzle",
+    "行为验证4.0",
+    "行为验证",
+    "DataDome CAPTCHA",
+    "CyberSiARA",
+    "MTCaptcha",
+    "Bounding Box Method",
+    "Friendly Captcha"
+  ],
+  "scripts": {
+    "go": "tsc && node ./dist/index.js",
+    "dev": "tsc && node ./issues/dev",
+    "jsdoc": "jsdoc",
+    "docgen": "tsc && yarn jsdoc ./dist -R \"./readme.md\" -P \"./package.json\" -t \"./node_modules/jaguarjs-jsdoc\" -d \"./docs\" -r",
+    "test": "tsc && node ./tests/mtCaptcha.js"
+  },
+  "dependencies": {
+    "node-fetch": "^2.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.7",
+    "@types/node-fetch": "^2.5.7",
+    "dotenv": "^16.0.3",
+    "jaguarjs-jsdoc": "^1.0.2",
+    "jsdoc": "^4.0.2",
+    "typescript": "^4.9.4"
+  }
+}

package/README.ru.md

@@ -1,385 +0,0 @@
-[English](README.md) | [中国语文科](README.zh.md) | <b>[Русский](README.ru.md)</b>
-
-# JavaScript модуль для 2Captcha API
-
-## Описание
-Оболочка вокруг API сервиса [2captcha](https://2captcha.com/). Эта оболочка поддерживает решение следующих типов капч: reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Coordinates (Click Captcha), Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile, Capy Puzzle, DataDome CAPTCHA, CyberSiARA, MTCaptcha, Friendly Captcha.
-
-Также добавлена поддержка метода `bounding_box`. Метод ограничивающей рамки позволяет размечать данные на изображении. Этот метод можно использовать для разметки наборов данных или выделения любых объектов на изображении в соответствии с заданными инструкциями. Подробнее об использовании *Bounding Box Method* читайте в [документации](https://2captcha.com/2captcha-api#bounding_box).
-
-[2captcha](https://2captcha.com/) это сервис, который решает множество различных типов капч. Эта библиотека служит оболочкой для API 2captcha, чтобы предоставить NodeJS простую функциональность, основанную на `promise`.
-
-## Поддерживаемые типы капч:
-- ✅ google-recaptcha (reCAPTCHA v2 / reCAPTCHA v3)
-- ✅ hCaptcha
-- ✅ Arkose Labs FunCaptcha
-- ✅ Image captchas. (`base64` format)
-- ✅ Geetest
-- ✅ Geetest v4
-- ✅ Yandex Smart Captcha
-- ✅ Lemin Cropped Captcha
-- ✅ Cloudflare Turnstile
-- ✅ Amazon WAF Captcha
-- ✅ Capy Puzzle
-- ✅ Coordinates (Click Captcha)
-- ⬜ Audio Recogntion
-- ✅ DataDome CAPTCHA
-- ✅ CyberSiARA
-- ✅ MTCaptcha
-- ✅ Friendly Captcha
-- ✅ Bounding Box Method
-
-
-## Установка
-
-```sh
-npm install @2captcha/captcha-solver
-```
-```sh
-yarn add @2captcha/captcha-solver
-```
-
-## Примеры использования
-
-
-### reCAPTCHA:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-// Новый экземпляр "solver" со значением вашего ключа 2captcha API
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-// Решение reCAPTCHA, на демо странице содержащей reCAPTCHA V2
-solver.recaptcha({
-  pageurl: 'https://2captcha.com/demo/recaptcha-v2',
-  googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u'
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### hCaptcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.hcaptcha({
-  pageurl: "https://2captcha.com/demo/hcaptcha?difficulty=moderate",
-  sitekey: "b76cd927-d266-4cfb-a328-3b03ae07ded6"
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Arkose Labs FunCaptcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.funCaptcha({
-  pageurl: "https://funcaptcha.com/tile-game-lite-mode/fc/api/nojs/?pkey=804380F4-6844-FFA1-ED4E-5877CA1F1EA4&lang=en",
-  publickey: "804380F4-6844-FFA1-ED4E-5877CA1F1EA4"
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Image captcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const fs = require("fs")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-// Получаем содержимое файла в формате base64
-const imageBase64 = fs.readFileSync("./tests/media/imageCaptcha_6e584.png", "base64")
-
-solver.imageCaptcha({
-    body: imageBase64,
-    numeric: 4,
-    min_len: 5,
-    max_len: 5
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-
-### GeeTest Captcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-// Значение `challenge` является динамическим
-// Читайте подробнее о `challenge` на странице https://2captcha.com/p/geetest
-solver.geetest({ 
-  pageurl: 'https://2captcha.com/demo/geetest',
-  gt: '81388ea1fc187e0c335c0a8907ff2625',
-  challenge: '<you need to get a new challenge value each time>'
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### GeeTest V4 Captcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.geetestV4({
-  pageurl: 'https://2captcha.com/demo/geetest-v4',
-  captcha_id: 'e392e1d7fd421dc63325744d5a2b9c73'
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Yandex Smart Captcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.yandexSmart({ 
-  pageurl: "https://captcha-api.yandex.ru/demo",
-  sitekey: "FEXfAbHQsToo97VidNVk3j4dC74nGW1DgdxjtNB9"
- })
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Lemin captcha:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.lemin({
-  pageurl:'https://dashboard.leminnow.com/auth/login', 
-  captcha_id: 'CROPPED_099216d_34698cb7b8574265925f493cbcb3df4d',
-  div_id: 'lemin-cropped-captcha',
-  api_server: 'https://api.leminnow.com/captcha/v1/cropped'
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Cloudflare Turnstile:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.cloudflareTurnstile({
-    pageurl: "https://app.nodecraft.com/login",
-    sitekey: "0x4AAAAAAAAkg0s3VIOD10y4"    
-})
-.then((res) => {
-    console.log(res);
-})
-.catch((err) => {
-    console.log(err);
-})
-```
-
-### Amazon WAF Captcha (AWS WAF):
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-// INFO: Значение `context` является динамическим, необходимо каждый раз брать фактическое значение со страницы с капчей.
-solver.amazonWaf({
-  pageurl: "https://non-existent-example.execute-api.us-east-1.amazonaws.com/latest",
-  sitekey: "AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AHMDLodoefdvyOnsHMRt...",
-  context: "9BUgmlm48F92WUoqv97a49ZuEJJ50TCk9MVr3C7WMtQ0X6flVbufM4n8mjFLmbLVAPgaQ...",
-  iv: "CgAHbCe2GgAAAAAj",
-})
-.then((res) => {
-  console.log(res);
-})
-.catch((err) => {
-  console.log(err);
-})
-```
-
-### Capy Puzzle
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.capyPuzzle({
-    pageurl: "https://www.capy.me/account/register/",
-    captchakey: "PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w"
-})
-.then((res) => {
-    console.log(res);
-})
-.catch((err) => {
-    console.log(err);
-})
-```
-
-### DataDome CAPTCHA
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-
-solver.dataDome({
-    pageurl: "https://rendezvousparis.hermes.com/client/register",
-    captcha_url: "https://geo.captcha-delivery.com/captcha/?initialCid=AHrlqAAAAAMAEuQtkf4k1c0ABZhYZA%3D%3D&hash=789361B674144528D0B7EE76B35826&cid=mY4z7GNmh7Nt1lAFwpbNHAOcWPhyPgjHD2K1Pm~Od1iEKYLUnK3t7N2ZGUj8OqDK65cnwJHtHwd~t902vlwpSBA5l4ZHbS1Qszv~jEuEUJNQ_jMAjar2Kj3kq20MRJYh&t=fe&referer=https%3A%2F%2Frendezvousparis.hermes.com%2Fclient%2Fregister&s=40119&e=67fef144ac1a54dbd7507776367d2f9d5e36ec3add17fa22f3cb881db8385838",
-    userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36",
-    proxy: "login:password@1.2.3.4:8888", // The (Username : Password @ Address : Port) of our chosen proxy
-    proxytype: "http" // The 'Type' of proxy, http, https, socks, ect.
-})
-.then((res) => {
-console.log(res);
-})
-.catch((err) => {
-console.log(err);
-})
-```
-
-### CyberSiARA
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-
-solver.cyberSiARA({
-    pageurl: "https://www.cybersiara.com/book-a-demo",
-    master_url_id: "OXR2LVNvCuXykkZbB8KZIfh162sNT8S2",
-    userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36"
-})
-.then((res) => {
-console.log(res);
-})
-.catch((err) => {
-console.log(err);
-})
-```
-
-### MTCaptcha
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-
-solver.mtCaptcha({
-    pageurl: "https://service.mtcaptcha.com/mtcv1/demo/index.html",
-    sitekey: "MTPublic-DemoKey9M"
-})
-.then((res) => {
-console.log(res);
-})
-.catch((err) => {
-console.log(err);
-})
-```
-
-### Friendly Captcha
-
-Используйте этот метод, чтобы решить Friendly Captcha и получить токен для обхода защиты.
-
-> **Важно:**Для успешного использования полученного токена, на странице не должен быть загружен виджет капчи. Для этого вам нужно прервать запрос к `/friendcaptcha/...module.min.js` на странице. Когда виджет капчи уже загружен на страницу, велика вероятность, что полученный токен не сработает.
-
-```js
-solver.friendlyCaptcha({
-    pageurl: "https://geizhals.de/?liftban=1&from=/455973138?fsean=5901747021356",
-    sitekey: "FCMST5VUMCBOCGQ9"
-})
-.then((res) => {
-console.log(res);
-})
-.catch((err) => {
-console.log(err);
-})
-```
-
-### Coordinates (Click Captcha):
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-const imageBase64 = fs.readFileSync("./tests/media/hCaptchaImage.jpg", "base64")
-
-solver.coordinates({
-    body: imageBase64,
-    textinstructions: 'Select all photos containing the boat'
- })
-.then((res) => {
-    console.log(res);
-})
-.catch((err) => {
-    console.log(err);
-})
-```
-
-### Bounding Box Method:
-*Bounding Box Method* позволяет выбирать объекты, указанные на изображении. Для этого вам необходимо передать инструкции по разметке. Инструкции могут быть отправлены в виде текста или изображения, закодированного в формате `base64`. Обязательно необходимо передать хотя бы одну инструкцию `imginstructions` или `textinstructions`.
-
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.boundingBox({ 
-  image: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAR4AAACwCAIAAAB...",
-  textinstructions: "Обведите все машины на изображении.",
-})
-.then((res) => {
-    console.log(res);
-})
-.catch((err) => {
-    console.log(err);
-})
-```
-
-### Proxy:
-```js
-const Captcha = require("@2captcha/captcha-solver")
-const solver = new Captcha.Solver("<Your 2captcha api key>")
-
-solver.recaptcha({
-  pageurl: 'https://2captcha.com/demo/recaptcha-v2',
-  googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',
-  proxy: "login:password@1.2.3.4:8888", // Параметры используемого вами прокси сервера
-  proxytype: "HTTP" // Тип используемого прокси: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
-})
-.then((res) => {
-  console.log(res)
-})
-.catch((err) => {
-  console.error(err.message)
-})
-```
-
-## Полезные статьи
-* [Как решать капчу Geetest v4](https://2captcha.com/ru/blog/geetest-v4-obkhod)
-* [Автоматическое решение reCAPTCHA V3 - инструкция для разработчиков и заказчиков](https://2captcha.com/ru/blog/avtomaticheskoe-reshenie-recaptcha-v3)
-* <a href="./docs/hcaptcha.md">Поиск значения `sitekey` для hCaptcha</a>