solvecaptcha-javascript
Version:
Node.js wrapper for SolveCaptcha.com API. Bypass recaptcha, hcaptcha, cloudflare capthca and more.
1,107 lines • 71.9 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Solver = void 0;
const node_fetch_1 = __importDefault(require("node-fetch"));
const solvecaptchaError_1 = require("./solvecaptchaError");
const utils = __importStar(require("../utils/generic"));
const providers_1 = __importDefault(require("./providers/providers"));
const constants_1 = require("./constants/constants");
const checkCaptchaParams_1 = __importDefault(require("../utils/checkCaptchaParams"));
const renameParams_1 = __importDefault(require("../utils/renameParams"));
const provider = (0, providers_1.default)();
/**
* The main solvecaptcha class, housing all API calls and api interactions.
*
*/
class Solver {
/**
* The constructor for the solvecaptcha Solver class.
*
* @param {string} apikey The API key to use
* @param {number} pollingFrequency The frequency to poll for requests
*
*/
constructor(apikey, pollingFrequency = 5000, enableACAO = true) {
this._apikey = apikey;
this._pollingFrequency = pollingFrequency;
this._headerACAO = enableACAO ? 1 : 0;
}
/** The API key this instance is using */
get apikey() {
return this._apikey;
}
/** Frequency the instance polls for updates */
get pollingFrequency() {
return this._pollingFrequency;
}
/** Set the API key for this instance */
set apikey(update) {
this._apikey = update;
}
get in() {
return provider.in;
}
get res() {
return provider.res;
}
get defaultPayload() {
return {
key: this.apikey,
json: 1,
header_acao: this._headerACAO,
soft_id: constants_1.softId,
};
}
/**
* Returns the remaining account balance.
*
* @return {Promise<Number>} Remaining balance
* @throws APIError
* @example
* solver.balance()
* .then((res) => {
* console.log(res)
* })
*/
async balance() {
const res = await (0, node_fetch_1.default)(this.res +
utils.objectToURI({
...this.defaultPayload,
action: "getbalance",
}));
const result = await res.text();
try {
const data = JSON.parse(result);
if (data.status == 1) {
return parseFloat(data.request);
}
throw new solvecaptchaError_1.APIError(data.request);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
}
/**
* @private
*
* Polls for a captcha, finding out if it's been completed
* @param {string} id Captcha ID
*
* @returns {Promise<CaptchaAnswer>}
* @throws APIError
*/
async pollResponse(id) {
const payload = {
...this.defaultPayload,
action: "get",
id: id,
};
await utils.sleep(this.pollingFrequency);
const res = await (0, node_fetch_1.default)(this.res + utils.objectToURI(payload));
const result = await res.text();
let data;
try {
data = JSON.parse(result);
if (data.status == 1) {
let dataJSON = { ...data, data: data.request, id: id };
delete dataJSON.request;
return dataJSON;
}
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
switch (data.request) {
case "CAPCHA_NOT_READY":
return this.pollResponse(id);
default: {
throw new solvecaptchaError_1.APIError(data.request);
}
}
}
/**
* ### Solves a google reCAPTCHA V2 | V3.
*
* [Read more about other reCAPTCHA parameters](https://solvecaptcha.com/solvecaptcha-api#solving_recaptchav2_new).
*
* @param {{pageurl, googlekey, cookies, proxy, proxytype, userAgent, invisible, datas, pingback, action, enterprise, min_score, version, domain}} params Object
* @param {string} params.pageurl The URL the captcha appears on.
* @param {string} params.googlekey Value of `k` or `data-sitekey` parameter you found on page.
* @param {string} params.cookies Your cookies that will be passed to our worker who solve the captha.
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128`. You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.userAgent Your `userAgent` that will be passed to our worker and used to solve the captcha.
* @param {number} params.invisible `1` - means that reCAPTCHA is invisible. `0` - normal reCAPTCHA.
* @param {string} params.datas Value of `data-s` parameter you found on page. Curenttly applicable for Google Search and other Google services.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.action Value of `action` parameter you found on page.
* @param {number} params.enterprise `1` - defines that you're sending reCAPTCHA Enterpise.
* @param {number} params.min_score The score needed for resolution reCAPTCHA V3. Currently it's almost impossible to get token with score higher than `0.3`
* @param {string} params.version `v2` — defines that you're sending a reCAPTCHA V2. `v3` — defines that you're sending a reCAPTCHA V3.
* @param {string} params.domain Domain used to load the captcha: `google.com` or `recaptcha.net`
*
* @returns {Promise<CaptchaAnswer>} The result from the solve.
* @throws APIError
* @example
* solver.recaptcha({
* pageurl: 'https://solvecaptcha.com/demo/recaptcha-v2',
* googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u'
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async recaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "userrecaptcha");
const payload = {
...params,
method: "userrecaptcha",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a hCaptcha
*
* [Read more about other hCaptcha parameters](https://solvecaptcha.com/solvecaptcha-api#solving_hcaptcha).
*
* @param {{sitekey, pageurl, data, userAgent, invisible, pingback, proxy, proxytype, domain}} params Object
* @param {string} params.sitekey The hcaptcha site key. Value of `k` or `data-sitekey` parameter you found on page.
* @param {string} params.pageurl The URL the captcha appears on.
* @param {string} params.data Custom `data` that is used in some implementations of hCaptcha, mostly with `invisible=1`. In most cases you see it as `rqdata` inside network requests. IMPORTANT: you MUST provide `userAgent` if you submit captcha with `data` paramater. The value should match the User-Agent you use when interacting with the target website.
* @param {string} params.userAgent Your userAgent that will be passed to our worker and used to solve the captcha. Required for hCaptcha with `data` parameter.
* @param {number} params.invisible Use `1` for invisible version of hcaptcha. Currently it is a very rare case.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. More info [here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.domain Domain used to load the captcha: `hcaptcha.com` or `js.hcaptcha.com`
*
* @returns {Promise<CaptchaAnswer>} The result from the solve
* @throws APIError
* @example
* solver.hcaptcha({
* pageurl: "https://solvecaptcha.com/demo/hcaptcha",
* sitekey: "b76cd927-d266-4cfb-a328-3b03ae07ded6"
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async hcaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "hcaptcha");
const payload = {
...params,
method: "hcaptcha",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a GeeTest Captcha.
*
* [Read more about parameters and solving for Geetest captcha](https://solvecaptcha.com/solvecaptcha-api#solving_geetest).
*
* @param {{ gt, challenge, api_server, offline, new_captcha,
* pageurl, pingback, proxy, proxytype, userAgent }} params
* @param {string} params.gt Value of gt parameter found on site
* @param {string} params.challenge Value of challenge parameter found on site
* @param {string} params.pageurl The URL the captcha appears on
* @param {string} params.api_server The URL of the api_server (recommended)
* @param {number} params.offline In rare cases `initGeetest` can be called with `offline` parameter on the target page. If the call uses offline: true, set the value to `1`.
* @param {number} params.new_captcha In rare cases `initGeetest` can be called with `new_captcha` parameter. If the call uses `new_captcha: true`, set the value to `1`. Mostly used with offline parameter.
* @param {string} params.pingback URL for `pingback` (callback) response that will be sent when captcha is solved. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128`. You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.userAgent Your `userAgent` that will be passed to our worker and used to solve the captcha.
*
* @returns {Promise<CaptchaAnswer>} The result from the solve.
* @throws APIError
* @example
* ;(async () => {
*
* // Warning: Attention, the `challenge` value is not static but dynamic.
* // You need to find the queries that makes the captcha on the page to API.
* // Then you need to make request to this API and get new `challenge`.
*
* // For page https://solvecaptcha.com/demo/geetest, api address is https://solvecaptcha.com/api/v1/captcha-demo/gee-test/init-params?t=${t}
* // Also note that when make request to API, the request uses the dynamic parameter `t`
*
* // You can read more about sending GeeTest here https://solvecaptcha.com/solvecaptcha-api#solving_geetest, or here https://solvecaptcha.com/p/geetest
* // In this example I solve GeeTest from page https://solvecaptcha.com/demo/geetest
*
* const t = new Date().getTime()
* // below i make a request to get a new `challenge`.
* const response = await fetch(`https://solvecaptcha.com/api/v1/captcha-demo/gee-test/init-params?t=${t}`)
* const data = await response.json()
*
* const params = {
* pageurl: 'https://solvecaptcha.com/demo/geetest',
* gt: data.gt,
* challenge: data.challenge
* }
*
* const res = await solver.geetest(params)
* try {
* console.log(res)
* } catch (error) {
* console.error(error);
* }
* })()
*/
async geetest(params) {
(0, checkCaptchaParams_1.default)(params, "geetest");
const payload = {
...params,
method: "geetest",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a GeeTest V4 Captcha.
*
* This method accepts an object with the following fields: `pageurl`, `captcha_id`, `pingback`, `proxy`, `proxytype`, `userAgent`.
* The `pageurl` and `captcha_id` fields are required.
*
* @param {{pageurl, captcha_id, pingback, proxy, proxytype, userAgent}} params The method geetestV4 takes arguments as an object.
* @param {string} params.pageurl Full URL of the page where you see Geetest V4 captcha.
* @param {string} params.captcha_id Required parameter. Value of `captcha_id` parameter you found on target website.
* @param {string} params.pingback An optional param. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy An optional param. Format: `login:password@123.123.123.123:3128`. You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype An optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.userAgent An optional param. Your `userAgent` that will be passed to our worker and used to solve the captcha.
*
* @returns {Promise<CaptchaAnswer>} The result from the solve.
* @throws APIError
* @example
* solver.geetestV4({
* pageurl: 'https://solvecaptcha.com/demo/geetest-v4',
* captcha_id: 'e392e1d7fd421dc63325744d5a2b9c73'
* })
* .then((res) => {
* console.log(res)
* })
* .catch((err) => {
* console.log(err);
* })
*/
async geetestV4(params) {
(0, checkCaptchaParams_1.default)(params, "geetest_v4");
const payload = {
...params,
method: "geetest_v4",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Method for sending Yandex Smart Captcha.
*
* This method accepts an object with the following fields: `pageurl`, `sitekey`, `pingback`, `proxy`, `proxytype`.
* The `pageurl` and `sitekey` fields are required.
*
* @param {{pageurl, sitekey, pingback, proxy, proxytype, userAgent}} params The method takes arguments as an object.
* @param {string} params.pageurl Required parameter. URL of the page where the captcha is located.
* @param {string} params.sitekey Required parameter. The `sitekey` value you found on the captcha page.
* @param {string} params.pingback An optional param.
* @param {string} params.proxy An optional param. Format: `login:password@123.123.123.123:3128`.
* @param {string} params.proxytype An optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.userAgent An optional param. Your `userAgent` that will be passed to our worker and used to solve the captcha.
*
* @returns {Promise<CaptchaAnswer>} The result from the solve.
* @throws APIError
* @example
* solver.yandexSmart({
* pageurl: "https://captcha-api.yandex.ru/demo",
* sitekey: "FEXfAbHQsToo97VidNVk3j4dC74nGW1DgdxjtNB9"
* })
* .then((res) => {
* console.log(res)
* })
* .catch((err) => {
* console.log(err);
* })
*/
async yandexSmart(params) {
(0, checkCaptchaParams_1.default)(params, "yandex");
const payload = {
...params,
method: "yandex",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a image-based captcha.
*
* [Read more about parameters for image captcha](https://solvecaptcha.com/solvecaptcha-api#solving_normal_captcha).
*
* @param {{ body,
* phrase,
* regsense,
* numeric,
* calc,
* min_len,
* max_len,
* language,
* lang,
* textinstructions,
* pingback }} params Extra properties to pass to solvecaptcha.
* @param {string} params.body Base64 image data for the captcha.
* @param {number} params.phrase Captcha contains two or more words? `1` - Yes. `0` - No.
* @param {number} params.regsense Captcha is case sensitive? `1` - Yes. `0` - No.
* @param {number} params.numeric `0` - not specified. `1` - captcha contains only numbers. `2` - captcha contains only letters. `3` - captcha contains only numbers OR only letters. `4` - captcha MUST contain both numbers AND letters.
* @param {number} params.calc Does captcha require calculations? (e.g. type the result 4 + 8 = ) `1` - Yes. `0` - No.
* @param {number} params.min_len `1..20` - minimal number of symbols in captcha. `0` - not specified.
* @param {number} params.max_len `1..20` - maximal number of symbols in captcha. `0` - not specified.
* @param {number} params.language `0` - not specified. `1` - Cyrillic captcha. `2` - Latin captcha
* @param {string} params.lang Language code. [See the list of supported languages](https://solvecaptcha.com/solvecaptcha-api#language).
* @param {string} params.textinstructions Text will be shown to worker to help him to solve the captcha correctly. For example: type red symbols only.
* @param {string} params.pingback URL for `pingback` (callback) response that will be sent when captcha is solved. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
*
* @returns {Promise<CaptchaAnswer>} The result from the solve
* @throws APIError
* @example
* 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);
* })
*/
async imageCaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "base64");
const payload = {
...params,
...this.defaultPayload,
method: "base64",
};
const URL = this.in;
const response = await (0, node_fetch_1.default)(URL, {
body: utils.toFormData(payload),
method: "post",
});
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves Arkose Labs FunCaptcha.
*
* [Read more](https://solvecaptcha.com/solvecaptcha-api#solving_funcaptcha_new) about other solving and other parameters for Arkose Labs FunCaptcha.
*
* @param {{pageurl, publicKey, surl, data, pingback, proxy, proxytype, userAgent}} params Object
* @param {string} params.publicKey The FunCaptcha Public Key
* @param {string} params.pageurl The URL to the website the captcha is seen on
* @param {string} params.surl The FunCaptcha Service URL (recommended)
* @param {string} params.data Custom data to pass to FunCaptcha. For example: `'data': '{"blob": "foo"}'`.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
* @param {string} params.userAgent Your `userAgent` that will be passed to our worker and used to solve the captcha.
*
* @returns {Promise<CaptchaAnswer>} The result from the solve
* @throws APIError
*
* @example
* 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);
* })
*/
async funCaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "funcaptcha");
const payload = {
...params,
method: "funcaptcha",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
*
* ### Solves a Lemin captcha
*
* [Read more about other Lemin captcha parameters](https://solvecaptcha.com/solvecaptcha-api#lemin).
*
* @param {{ pageurl, captcha_id, div_id, api_server, pingback, proxy, proxytype}} params Object
* @param {string} params.pageurl The URL the captcha appears on.
* @param {string} params.captcha_id Value of `captcha_id` parameter you found on page.
* @param {string} params.div_id Value `id` of captcha pareent `<div></div>` element.
* @param {string} params.api_server The domain part of script URL you found on page. Default value: `https://api.leminnow.com/`
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.lemin({
* pageurl:'https://solvecaptcha.com/demo/lemin',
* captcha_id: 'CROPPED_3dfdd5c_d1872b526b794d83ba3b365eb15a200b',
* div_id: 'lemin-cropped-captcha',
* api_server: 'api.leminnow.com'
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async lemin(params) {
(0, checkCaptchaParams_1.default)(params, "lemin");
const payload = {
...params,
method: "lemin",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
*
* ### Solves Amazon WAF captcha
*
* [Read more about "Amazon WAF" captcha](https://solvecaptcha.com/solvecaptcha-api#amazon-waf).
*
* @param {{ pageurl, sitekey, iv, context, challenge_script, captcha_script, pingback, proxy, proxytype}} params The `amazonWaf` method takes arguments as an object. Thus, the `pageurl`, `sitekey`, `iv`, `context` fields in the passed object are mandatory.
* @param {string} params.pageurl Is the full `URL` of page where you were challenged by the captcha.
* @param {string} params.sitekey Is a value of `key` parameter in the page source.
* @param {string} params.iv Is a value of `iv` parameter in the page source.
* @param {string} params.context Is a value of `context` parameter in the page source.
* @param {string} params.challenge_script The source URL of `challenge.js` script on the page.
* @param {string} params.captcha_script The source URL of `captcha.js` script on the page.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.amazonWaf({
* pageurl: "https://non-existent-example.execute-api.us-east-1.amazonaws.com/latest",
* sitekey: "AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AHMDLodoefdvyOnsHMRtEKQAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMUX+ZqwwuANRnZujSAgEQgDvHSxUQmVBuyUtumoW2n4ccTG7xQN1r3X/zz41qmQaYv9SSSvQrjIoDXKaUQ23tVb4ii8+uljuRdz/HPA==",
* context: "9BUgmlm48F92WUoqv97a49ZuEJJ50TCk9MVr3C7WMtQ0X6flVbufM4n8mjFLmbLVAPgaQ1Jydeaja94iAS49ljb+sUNLoukWedAQZKrlY4RdbOOzvcFqmD/ZepQFS9N5w15Exr4VwnVq+HIxTsDJwRviElWCdzKDebN/mk8/eX2n7qJi5G3Riq0tdQw9+C4diFZU5E97RSeahejOAAJTDqduqW6uLw9NsjJBkDRBlRjxjn5CaMMo5pYOxYbGrM8Un1JH5DMOLeXbq1xWbC17YSEoM1cRFfTgOoc+VpCe36Ai9Kc=",
* iv: "CgAHbCe2GgAAAAAj",
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async amazonWaf(params) {
(0, checkCaptchaParams_1.default)(params, "amazon_waf");
const payload = {
...params,
method: "amazon_waf",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
*
* ### Solves Cloudflare Turnstile captcha
*
* [Read more about Cloudflare Turnstile captcha](https://solvecaptcha.com/solvecaptcha-api#turnstile).
*
* @param {{ pageurl, sitekey, action, data, pingback, proxy, proxytype}} params The `cloudflareTurnstile` method takes arguments as an object. Thus, the `pageurl`, `sitekey` fields in the passed object are mandatory.
* @param {string} params.pageurl Full `URL` of the page where you see the captcha.
* @param {string} params.sitekey Is a value of `sitekey` parameter in the page source.
* @param {string} params.action Value of optional `action` parameter you found on page.
* @param {string} params.data Value of optional `data` parameter you found on page.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.cloudflareTurnstile({
* pageurl: "https://app.nodecraft.com/login",
* sitekey: "0x4AAAAAAAAkg0s3VIOD10y4"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async cloudflareTurnstile(params) {
(0, checkCaptchaParams_1.default)(params, "turnstile");
const payload = {
...params,
method: "turnstile",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a Coordinates captcha.
*
* @param {{ body, imginstructions, textinstructions, language, lang, pingback }} params parameters Coordinates Captcha as an object.
* @param {string} params.body Base64-encoded captcha image.
* @param {string} params.imginstructions Base64-encoded image with instruction for solving captcha.
* @param {string} params.textinstructions Text will be shown to worker to help him to solve the captcha correctly. For example: click on all objects in red color.
* @param {number} params.language `0` - not specified. `1` - Cyrillic captcha. `2` - Latin captcha
* @param {string} params.lang Language code. [See the list of supported languages](https://solvecaptcha.com/solvecaptcha-api#language).
* @param {string} params.pingback URL for `pingback` (callback) response that will be sent when captcha is solved. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
*
* @returns {Promise<CaptchaAnswer>} The result from the solve
*
* @example
* 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);
* })
*/
async coordinates(params) {
(0, checkCaptchaParams_1.default)(params, "base64");
const payload = {
...params,
method: "base64",
coordinatescaptcha: 1,
...this.defaultPayload,
};
const URL = this.in;
const response = await (0, node_fetch_1.default)(URL, {
method: "post",
body: utils.toFormData(payload),
});
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves Capy Puzzle captcha
*
* @param {{ pageurl, captchakey, api_server, version, pingback, proxy, proxytype}} params Parameters Capy Puzzle Captcha as an object.
* @param {string} params.pageurl Full `URL`of the page where you see the captcha.
* @param {string} params.captchakey Value of `captchakey` parameter you found on page.
* @param {string} params.api_server The domain part of script URL you found on page. Default value: `https://jp.api.capy.me/`.
* @param {string} params.version The version of captcha task: `puzzle` (assemble a puzzle) or `avatar` (drag an object)..
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.capyPuzzle({
* pageurl: "https://www.capy.me/account/register/",
* captchakey: "PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async capyPuzzle(params) {
(0, checkCaptchaParams_1.default)(params, "capy");
const payload = {
...params,
method: "capy",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves DataDome captcha
*
* @param {{ pageurl, captcha_url, userAgent, pingback, proxy, proxytype}} params Parameters DataDome Captcha as an object.
* @param {string} params.pageurl Full `URL` of the page where you see the captcha.
* @param {string} params.captcha_url The value of the `src` parameter for the `iframe` element containing the captcha on the page.
* @param {string} params.userAgent ser-Agent of your MODERN browser
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* 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: "1.2.3.4:8888:user:password",
* proxytype: "http"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async dataDome(params) {
(0, checkCaptchaParams_1.default)(params, "datadome");
const payload = {
...params,
method: "datadome",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves CyberSiARA captcha
*
* @param {{ pageurl, master_url_id, userAgent, pingback, proxy, proxytype}} params Parameters CyberSiARA Captcha as an object.
* @param {string} params.pageurl Full `URL` of the page where you see the captcha.
* @param {string} params.master_url_id The value of `MasterUrlId` parameter obtained from the request to the endpoint `API/CyberSiara/GetCyberSiara`.
* @param {string} params.userAgent ser-Agent of your MODERN browser
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* 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);
* })
*/
async cyberSiARA(params) {
(0, checkCaptchaParams_1.default)(params, "cybersiara");
const payload = {
...params,
method: "cybersiara",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves MTCaptcha
*
* @param {{ pageurl, sitekey, userAgent, pingback, proxy, proxytype}} params Parameters MTCaptcha as an object.
* @param {string} params.pageurl Full `URL` of the page where you see the captcha.
* @param {string} params.sitekey TThe value of `sitekey` parameter found on the page.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.mtCaptcha({
* pageurl: "https://service.mtcaptcha.com/mtcv1/demo/index.html",
* sitekey: "MTPublic-DemoKey9M"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async mtCaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "mt_captcha");
const payload = {
...params,
method: "mt_captcha",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves a Cutcaptcha.
*
* Use this method to solve Cutcaptcha. Returns the response in JSON.
* [Read more about Cutcaptcha Method](https://solvecaptcha.com/solvecaptcha-api#cutcaptcha).
*
* @param {{ pageurl, miseryKey, apiKey, pingback, proxy, proxytype }} params Parameters for solving Cutcaptcha as an object.
* @param {string} params.pageurl The URL where the captcha is located.
* @param {string} params.miseryKey The value of `CUTCAPTCHA_MISERY_KEY` variable defined on page.
* @param {string} params.apiKey The value of `data-apikey` attribute of iframe's body. Also the name of javascript file included on the page
* @param {string} [params.pingback] Optional param. URL for pingback (callback) response when captcha is solved.
* @param {string} [params.proxy] Optional param. Proxy to use while solving the captcha. Format: `login:password@123.123.123.123:3128`.
* @param {string} [params.proxytype] Optional param. Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @returns {Promise<CaptchaAnswer>} The result from the solve.
* @throws APIError
*
* @example
* solver.cutCaptcha({
* pageurl: "https://mysite.com/page/with/cutcaptcha",
* miseryKey: "098e6a849af406142e3150dbf4e6d0538db2b51f",
* apiKey: "SAs61IAI",
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async cutCaptcha(params) {
params = (0, renameParams_1.default)(params);
(0, checkCaptchaParams_1.default)(params, "cutcaptcha");
const payload = {
...params,
method: "cutcaptcha",
...this.defaultPayload,
};
const URL = this.in;
const response = await (0, node_fetch_1.default)(URL, {
body: utils.toFormData(payload),
method: "post",
});
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Solves Friendly Captcha
*
* @param {{ pageurl, sitekey, pingback, proxy, proxytype}} params Parameters Friendly Captcha as an object.
* @param {string} params.pageurl Full `URL` of the page where you see the captcha.
* @param {string} params.sitekey The value of `data-apikey` or `data-sitekey` parameter found on the page.
* @param {string} params.pingback URL for pingback (callback) response that will be sent when captcha is solved. URL should be registered on the server. [More info here](https://solvecaptcha.com/solvecaptcha-api#pingback).
* @param {string} params.proxy Format: `login:password@123.123.123.123:3128` You can find more info about proxies [here](https://solvecaptcha.com/solvecaptcha-api#proxies).
* @param {string} params.proxytype Type of your proxy: `HTTP`, `HTTPS`, `SOCKS4`, `SOCKS5`.
*
* @example
* solver.friendlyCaptcha({
* pageurl: "https://geizhals.de/?liftban=1&from=/455973138?fsean=5901747021356",
* sitekey: "FCMST5VUMCBOCGQ9"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async friendlyCaptcha(params) {
(0, checkCaptchaParams_1.default)(params, "friendly_captcha");
const payload = {
...params,
method: "friendly_captcha",
...this.defaultPayload,
};
const response = await (0, node_fetch_1.default)(this.in + utils.objectToURI(payload));
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.request);
}
}
/**
* ### Bounding Box Method
*
* @param {{ image, textinstructions, imginstructions }} params Parameters Bounding Box Method as an object.
* @param {string} params.image Image containing data for markup. The image must be encoded in `Base64` format.
* @param {string} params.textinstructions Text will be shown to worker to help him to select object on the image correctly. For example: "*Select cars in the image*". **Optional parameter**, if the instruction already exists in the form of the `imginstructions`.
* @param {string} params.imginstructions Image with instruction for worker to help him to select object on the image correctly. The image must be encoded in `Base64` format. **Optional parameter**, if the instruction already exists in the form of the `textinstructions`.
*
* @example
* solver.boundingBox({
* image: "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgG...",
* textinstructions: "Select cars in the image"
* })
* .then((res) => {
* console.log(res);
* })
* .catch((err) => {
* console.log(err);
* })
*/
async boundingBox(params) {
(0, checkCaptchaParams_1.default)(params, "bounding_box");
const payload = {
...params,
method: "bounding_box",
...this.defaultPayload,
};
const URL = this.in;
const response = await (0, node_fetch_1.default)(URL, {
body: utils.toFormData(payload),
method: "post",
});
const result = await response.text();
let data;
try {
data = JSON.parse(result);
}
catch {
throw new solvecaptchaError_1.APIError(result);
}
if (data.status == 1) {
return this.pollResponse(data.request);
}
else {
throw new solvecaptchaError_1.APIError(data.req