@antiadmin/anticaptchaofficial
Version:
Official Anti-Captcha.com npm library
470 lines (403 loc) • 14.7 kB
Markdown
## Official Anti-Captcha.com npm module ##
### Contents
- [Intro](#)
- [Installation](#module-installation)
- [Request API key balance](#import-and-check-your-balance-in-sync-mode)
- [Earn with us](#earn-with-anti-captcha)
- [Image Captcha](#solve-image-captcha)
- [Recaptcha V2](#recaptcha-v2-without-proxy)
- [Recaptcha V3](#recaptcha-v3)
- [Hcaptcha](#hcaptcha-without-proxy)
- [Turnstile](#turnstile-without-proxy)
- [Antigate tasks](#antigate-tasks)
- [Funcaptcha](#funcaptcha--arkoselabs-without-proxy)
- [Geetest v3](#geetest-version-3-without-proxy)
- [Geetest v4](#geetest-version-4-without-proxy)
- [Image to coordinates](#image-to-coordinates)
- [Amazon WAF](#amazon-waf-without-proxy)
Official anti-captcha.com npm package for solving images with text, Recaptcha v2/v3 Enterprise/non-Enterpise, Funcaptcha, GeeTest, HCaptcha.
[Anti-captcha](https://anti-captcha.com) is an oldest and cheapest web service dedicated to solving captchas by human workers from around the world. By solving captchas with us you help people in poorest regions of the world to earn money, which not only cover their basic needs, but also gives them ability to financially help their families, study and avoid jobs where they're simply not happy.
To use the service you need to [register](https://anti-captcha.com/clients/) and topup your balance. Prices start from $0.0005 per image captcha and $0.002 for Recaptcha. That's $0.5 per 1000 for images and $2 for 1000 Recaptchas.
For more technical information and articles visit our [documentation](https://anti-captcha.com/apidoc) page.
### Module installation:
```bash
npm install @antiadmin/anticaptchaofficial
```
### Import and check your balance in sync mode:
```javascript
(async() => {
const ac = require("@antiadmin/anticaptchaofficial");
ac.setAPIKey('YOUR_API_KEY');
try {
const balance = await ac.getBalance();
console.log(`my balance is $${balance}`);
if (balance <= 0) {
throw "negative balance"
}
console.log("solving a captcha..")
// const token = await ac.solveRecaptchaV2Proxyless('http://DOMAIN.COM', 'WEBSITE_KEY');
// const fs = require('fs');
// const text = await ac.solveImage(fs.readFileSync('captcha.png', { encoding: 'base64' }), true)
} catch (e) {
console.log("got error: ", e.toString());
}
})();
```
Or do the same with promises:
```javascript
const ac = require("@antiadmin/anticaptchaofficial");
ac.setAPIKey('YOUR_API_KEY');
ac.getBalance()
.then(balance => {
console.log('my balance is $' + balance)
if (balance <= 0) {
return false;
}
console.log("solving a captcha..")
// ac.solveRecaptchaV2Proxyless('http://DOMAIN.COM', 'WEBSITE_KEY')
// .then(token => {
// console.log('Got g-response:', token)
// // do something
// })
// .catch(error => {
// console.log('test received error ' + error)
// return false;
// });
})
.catch(error => console.log('received error '+error))
```
Disable verbose output to console:
```javascript
ac.shutUp();
```
<br>
Request subscription credits balance:
```javascript
const remainingCredits = await ac.getCreditsBalance();
```
<br>
### Earn with Anti-Captcha
Specify softId to earn __10% commission__ from all captcha spendings with your app.
Get your softId in [Developers Center](https://anti-captcha.com/clients/tools/devcenter).
```javascript
ac.setSoftId(SOFT_ID_NUMBER);
```
### Solve image captcha:
```javascript
const fs = require('fs');
const captcha = fs.readFileSync('captcha.png', { encoding: 'base64' });
// Additional flags, see https://anti-captcha.com/apidoc/task-types/ImageToTextTask for description:
// ac.settings.phrase = true; // 2 words
// ac.settings.case = true; // case sensitivity
// ac.settings.numeric = 1; // only numbers
// ac.settings.comment = "only green letters"; // text comment for workers
// ac.settings.math = true; // math operation like 50+2
// ac.settings.minLength = 1; // minimum amount of characters
// ac.settings.maxLength = 10; // maximum number of characters
// ac.settings.languagePool = 'en'; // language pool
const text = await ac.solveImage(captcha, true);
```
Report last solved image captcha as incorrect (must read [this](https://anti-captcha.com/apidoc/methods/reportIncorrectImageCaptcha) before using):
```javascript
await ac.reportIncorrectImageCaptcha();
```
---
### Recaptcha V2 without proxy:
```javascript
ac.settings.recaptchaDataSValue = 'set me for google.com domains';
const gresponse = ac.solveRecaptchaV2Proxyless('http://DOMAIN.COM', 'WEBSITE_KEY');
console.log('g-response: '+gresponse);
console.log('google cookies:');
console.log(ac.getCookies());
```
Learn what to do with g-response in [this](https://anti-captcha.com/apidoc/articles/how-to-use-g-response) article.
Report last solved Recaptcha v2/v3 as incorrect (must read [this](https://anti-captcha.com/apidoc/methods/reportIncorrectRecaptcha) before using):
```javascript
await ac.reportIncorrectRecaptcha();
```
Report Recaptcha v3 as correctly solved (more info [here](https://anti-captcha.com/apidoc/methods/reportCorrectRecaptcha) before using):
```javascript
await ac.reportCorrectRecaptcha();
```
### Recaptcha V2 with proxy:
```javascript
const gresponse = await ac.solveRecaptchaV2ProxyOn('http://DOMAIN.COM',
'WEBSITE_KEY',
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD',
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116',
'some=cookies');
```
Solve Recaptcha V2-invisible (note the 3rd parameter "true"):
```javascript
const gresponse = await ac.solveRecaptchaV2Proxyless('http://DOMAIN.COM', 'WEBSITE_KEY', true)
```
---
### Recaptcha V3:
```javascript
const gresponse = await ac.solveRecaptchaV3('http://DOMAIN.COM',
'WEBSITE_KEY',
0.3, //minimum score required: 0.3, 0.7 or 0.9
'PAGE_ACTION_CAN_BE_EMPTY');
```
Solve Recaptcha V2 Enterprise without proxy:
```javascript
const gresponse = await ac.solveRecaptchaV2EnterpriseProxyless(
'http://DOMAIN.COM',
'WEBSITE_KEY',
{ //enterprise payload:
"s" : "SOME_TOKEN",
"custom_parameter" : "string_number_boolean"
});
```
---
### HCaptcha without proxy:
```javascript
const token = await ac.solveHCaptchaProxyless('http://DOMAIN.COM', 'WEBSITE_KEY', 'FULL USER AGENT HERE');
// use this userAgent for posting the form with token!
const userAgent = ac.getHcaptchaUserAgent();
//some Hcaptchas also produce "respkey" value, this is how to get it:
const respKey = ac.getHcaptchaRespKey();
```
Report last solved Hcaptcha as incorrect:
```javascript
await ac.reportIncorrectHcaptcha();
```
---
### Turnstile without proxy:
```javascript
const token = await ac.solveTurnstileProxyless('http://DOMAIN.COM', 'WEBSITE_KEY', 'optional_action', 'optional_cData_token');
```
---
### Turnstile with proxy:
```javascript
const token = await ac.solveTurnstileProxyOn('http://DOMAIN.COM',
'WEBSITE_KEY',
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD',
'optional_action',
'optional_cData_token');
```
---
### AntiGate Tasks:
```javascript
const solution = await ac.solveAntiGateTask(
'http://antigate.com/logintest.php',
'Sign-in and wait for control text',
{
"login_input_css": "#login",
"login_input_value": "the login",
"password_input_css": "#password",
"password_input_value": "the password",
"control_text": "You have been logged successfully"
});
console.log('cookies: ', solution.cookies);
console.log('localStorage: ', solution.localStorage);
console.log('url: ', solution.url);
```
same with a proxy:
```javascript
const solution = await ac.solveAntiGateTask(
'http://antigate.com/logintest.php',
'Sign-in and wait for control text',
{
"login_input_css": "#login",
"login_input_value": "the login",
"password_input_css": "#password",
"password_input_value": "the password",
"control_text": "You have been logged successfully"
},
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD');
```
Send a task with a delayed variable and push it after a few seconds:
```javascript
const taskId = await ac.sendAntiGateTask('http://antigate.com/logintest2fa.php',
'Sign-in with 2FA and wait for control text',
{
"login_input_css": "#login",
"login_input_value": "the login",
"password_input_css": "#password",
"password_input_value": "the password",
"2fa_input_css": "#2facode",
"2fa_input_value": "_WAIT_FOR_IT_",
"control_text": "You have been logged successfully"
});
await ac.delay(5000); //simulate a delay in 2FA retrieval
await ac.pushAntiGateVariable('2fa_input_value', '349001');
const solution = await ac.waitForResult(taskId);
console.log('solution:');
console.log(solution);
```
### Funcaptcha / Arkoselabs without proxy:
```javascript
//optional data blob:
ac.settings.funcaptchaDataBlob = 'blob value here is any, or leave it empty';
const token = await ac.solveFunCaptchaProxyless(
'https://www.thewebsite.com/path',
'site-key');
```
### Funcaptcha / Arkoselabs via proxy:
```javascript
//optional data blob:
ac.settings.funcaptchaDataBlob = 'blob value here is any, or leave it empty';
const token = await ac.solveFunCaptchaProxyOn(
'https://www.thewebsite.com/path',
'site-key',
'http',
'1.2.3.4',
3128,
'proxy-login',
'proxy-password',
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116',
'');
```
---
### Geetest version 3 without proxy
[See tutorial](https://anti-captcha.com/tutorials/how-to-use-chrome-breakpoints-for-finding-funcaptcha-and-geetest-api-parameters) how to find these parameters.
```javascript
const token = await ac.solveGeeTestProxyless(
'https://www.thewebsite.com/path',
'gt key 32 bytes',
'challenge value 32 bytes',
'optional.api-domain.com');
```
### Geetest version 4 without proxy
[See tutorial](https://anti-captcha.com/tutorials/how-to-use-chrome-breakpoints-for-finding-funcaptcha-and-geetest-api-parameters) how to find these parameters.
```javascript
const token = await ac.solveGeeTestV4Proxyless(
'https://www.thewebsite.com/path',
'captchaId key 32 bytes',
'optional.api-domain.com',
{
'riskType': 'slide' //example
});
```
---
### Image to coordinates
```javascript
const fs = require('fs');
const captcha = fs.readFileSync('captcha.png', { encoding: 'base64' });
const coordinates = await ac.solveImageToCoordinates(captcha, "Select all objects in specified order", "points");
```
Report last solved image captcha as incorrect:
```javascript
await ac.reportIncorrectImageCaptcha();
```
---
### Prosopo captcha
```javascript
const token = await ac.solveProsopoProxyless('http://DOMAIN.COM', 'WEBSITE_KEY');
```
---
Solve Prosopo captcha with proxy:
```javascript
const token = await ac.solveProsopoProxyOn('http://DOMAIN.COM',
'WEBSITE_KEY',
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD');
```
---
### Friendly Captcha without proxy:
```javascript
const token = await ac.solveFriendlyCaptchaProxyless('http://DOMAIN.COM', 'WEBSITE_KEY');
```
---
Solve Friendly Captcha with proxy:
```javascript
const token = await ac.solveFriendlyCaptchaProxyOn('http://DOMAIN.COM',
'WEBSITE_KEY',
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD');
```
---
### Amazon WAF:
Two options here:
1. When captcha is at the bot filtering page and you need aws-was-token cookie:
#### without proxy:
```javascript
const token = await ac.solveAmazonProxyless('http://DOMAIN.COM',
'key_value_from_window.gokuProps_object',
'iv_value_from_window.gokuProps_object',
'context_value_from_window.gokuProps_object',
'https://e9b10f157f38.9a96e8b4.us-gov-west-1.captcha.awswaf.com/e9b10f157f38/76cbcde1c834/2a564e323e7b/captcha.js', //optional
'https://e9b10f157f38.9a96e8b4.us-gov-west-1.token.awswaf.com/e9b10f157f38/76cbcde1c834/2a564e323e7b/challenge.js' //optional
);
```
#### with proxy:
```javascript
const token = await ac.solveAmazonProxyOn('http://DOMAIN.COM',
'key_value_from_window.gokuProps_object',
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD',
'iv_value_from_window.gokuProps_object',
'context_value_from_window.gokuProps_object',
'https://e9b10f157f38.9a96e8b4.us-gov-west-1.captcha.awswaf.com/e9b10f157f38/76cbcde1c834/2a564e323e7b/captcha.js', //optional
'https://e9b10f157f38.9a96e8b4.us-gov-west-1.token.awswaf.com/e9b10f157f38/76cbcde1c834/2a564e323e7b/challenge.js' //optional
);
```
2. When captcha is a standalone widget which is triggered by user's action:
#### without proxy:
```javascript
const token = await ac.solveAmazonWidgetProxyless('http://DOMAIN.COM',
'widget_api_key', // get key from AwsWafCaptcha.renderCaptcha function
'https://164cb210e333.edge.captcha-sdk.awswaf.com/164cb210e333/jsapi.js' // full path to jsapi.js integration script
);
```
#### with proxy:
```javascript
const token = await ac.solveAmazonWidgetProxyOn('http://DOMAIN.COM',
'widget_api_key',
'https://164cb210e333.edge.captcha-sdk.awswaf.com/164cb210e333/jsapi.js', // full path to jsapi.js integration script
'http', //http, socks4, socks5
'PROXY_IP',
'PROXY_PORT',
'PROXY_LOGIN',
'PROXY_PASSWORD'
);
```
For more details visit [Anti-Captcha Amazon WAF documentation](https://anti-captcha.com/apidoc/task-types/AmazonTaskProxyless).
---
Other available task types with similar method calls, see source code:
```javascript
await ac.solveRecaptchaV2EnterpriseProxyOn( ... ); //Recaptcha V2 Enterprise with proxy
await ac.solveRecaptchaV3Enterprise( ... ); //Recaptcha V3 Enterprise
await ac.solveHCaptchaProxyOn( ... ); //hCaptcha with proxy
await ac.solveGeeTestProxyOn( ... ); //Solve Geetest with proxy
await ac.solveGeeTestV4ProxyOn( ... ); //Bypass Geetest V4 with proxy
```