- Notifications
You must be signed in to change notification settings - Fork6
JavaScript package for easy integration with the API of 2captcha captcha solving service to bypass recaptcha, hcaptcha, Cloudflare turnstile, funcaptcha, geetest and solve any other captchas.
License
dzmitry-duboyski/2captcha-ts
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
The easiest way to quickly integrate the2Captcha captcha-solving service into your code and automate the solving of any type of captcha.
- JavaScript captcha solver module for 2Captcha API
This package can be installed with NPM:
npm install 2captcha-ts
or Yarn:
yarn add 2captcha-ts
TwoCaptcha instance can be created like this:
constTwoCaptcha=require("2captcha-ts")constsolver=newTwoCaptcha.Solver("<Your 2captcha api key>")
Also, there are a few options that can be configured:
constapiKey='YOUR_API_KEY'constpollingInterval=10constsolver=newTwoCaptcha.Solver(apiKey,pollingInterval)
Option | Default value | Description |
---|---|---|
apiKey | - | Your API key |
pollingInterval | 5000 | Interval in milliseconds between requests to theres.php API endpoint. Setting values less than 5 seconds is not recommended |
When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.
Option | Default Value | Description |
---|---|---|
numeric | 0 | Defines if the captcha contains numeric or other symbolssee more info in the API docs |
min_len | 0 | minimal answer length |
max_len | 0 | maximum answer length |
phrase | 0 | defines if the answer contains multiple words or not |
regsense | 0 | defines if the answer is case sensitive |
calc | 0 | defines captcha requires calculation |
lang | - | defines the captcha language; see thelist of supported languages |
textinstructions | - | hint or task text shown to workers with the captcha |
Below you can find basic examples for every captcha type, check out the code below.
To bypass a normal captcha (distorted text on an image) use the following method. This method can also be used to recognize any text in an image.
// Read from a file as base64 textconstimageBase64=fs.readFileSync("./examples/media/imageCaptcha_6e584.png","base64")solver.imageCaptcha({body:imageBase64,numeric:4,min_len:5,max_len:5}).then((res)=>{// Logs the image textconsole.log(res);}).catch((err)=>{console.log(err);})
Use the following method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
solver.recaptcha({pageurl:'https://2captcha.com/demo/recaptcha-v2',googlekey:'6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u'}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
This method provides a reCAPTCHA V3 solver and returns a token.
solver.recaptcha({pageurl:'https://2captcha.com/demo/recaptcha-v3',googlekey:'6Lcyqq8oAAAAAJE7eVJ3aZp_hnJcI6LgGdYD8lge',version:"v3",min_score:"0.4",action:'demo_action'}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha.
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);})
FunCaptcha (Arkoselabs) solving method. Returns a token.
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);})
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
// Read more about `challenge` on the page https://2captcha.com/p/geetestsolver.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);})
Use this method to solve GeeTest v4. Returns the response in JSON.
solver.geetestV4({pageurl:'https://2captcha.com/demo/geetest-v4',captcha_id:'e392e1d7fd421dc63325744d5a2b9c73'}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve Yandex Smart Captcha and obtain a token to bypass the protection.
solver.yandexSmart({pageurl:"https://captcha-api.yandex.ru/demo",sitekey:"FEXfAbHQsToo97VidNVk3j4dC74nGW1DgdxjtNB9"}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve Lemin and obtain a token to bypass the protection.
solver.lemin({pageurl:'https://2captcha.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);})
Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
Turnstile captcha has two types, one of them is Cloudflare Turnstile Challenge page. For Turnstile Challenge page cases, we have ademo. Try thisdemo if you need to solve Cloudflare Turnstile Challenge page captcha.
solver.cloudflareTurnstile({pageurl:"https://app.nodecraft.com/login",sitekey:"0x4AAAAAAAAkg0s3VIOD10y4"}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve Amazon WAF Captcha also known as AWS WAF Captcha is a part of Intelligent threat mitigation for Amazon AWS. Returns JSON with the token.
//INFO: The `context` value is dynamic, it is necessary to take the actual value from the page each time.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);})
Token-based method to bypass Capy puzzle captcha.
solver.capyPuzzle({pageurl:"https://www.capy.me/account/register/",captchakey:"PUZZLE_Cme4hZLjuZRMYC3uh14C52D3uNms5w"}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
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 useresidential proxies.
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 proxyproxytype:"http"// The 'Type' of proxy, http, https, socks, ect.}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve CyberSiARA and obtain a token to bypass the protection.
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);})
Use this method to solve MTCaptcha and obtain a token to bypass the protection.
solver.mtCaptcha({pageurl:"https://service.mtcaptcha.com/mtcv1/demo/index.html",sitekey:"MTPublic-DemoKey9M"}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to solve Friendly Captcha and obtain a token to bypass the protection.
Important
To successfully use the received token, the captcha widget must not be loaded on the page. To do this, you need to abort request to/friendlycaptcha/...module.min.js
on the page. When the captcha widget is already loaded on the page, there is a high probability that the received token will not work.
solver.friendlyCaptcha({pageurl:"https://geizhals.de/?liftban=1&from=/455973138?fsean=5901747021356",sitekey:"FCMST5VUMCBOCGQ9"}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
The ClickCaptcha method returns the coordinates of points on the captcha image. It can be used if you need to click on particular points in the image.
constimageBase64=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);})
Use Bounding Box Method when you need to select objects on the image. To do this, you need to pass the markup instructions and image for markup. The instructions can be sent as text or as an image encoded inbase64
format.
Important
You must to send instructionimginstructions
ortextinstructions
.
solver.boundingBox({image:"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAR4AAACwCAIAAAB...",textinstructions:"Circle all the cars in the image.",}).then((res)=>{console.log(res);}).catch((err)=>{console.log(err);})
Use this method to report good captcha answer.
solver.goodReport('7031846604')
Use this method to report bad captcha answer.
solver.badReport('7031854546')
Use this method to get your account's balance.
solver.balance().then((res)=>{console.log(res)})
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:
solver.recaptcha({pageurl:'https://2captcha.com/demo/recaptcha-v2',googlekey:'6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u',proxy:'HTTPS',proxytype:'login:password@123.123.123.123:3128'})
Examples of solving all supported captcha types are located in theexamples directory.
About
JavaScript package for easy integration with the API of 2captcha captcha solving service to bypass recaptcha, hcaptcha, Cloudflare turnstile, funcaptcha, geetest and solve any other captchas.
Topics
Resources
License
Stars
Watchers
Forks
Packages0
Languages
- TypeScript100.0%