github.com/2captcha/2captcha-go
The easiest way to quickly integrate 2Captcha into your code to automate solving of any type of captcha. Examples of API requests for different captcha types are available on the Golang captcha solver page.
To install the api client, use this:
go get -u github.com/2captcha/2captcha-go
Import the module like this:
import (
"github.com/2captcha/2captcha-go"
)
Client instance can be created like this:
client := api2captcha.NewClient("YOUR_API_KEY")
There are few options that can be configured:
client.SoftId = 123
client.Callback = "https://your.site/result-receiver"
client.DefaultTimeout = 120
client.RecaptchaTimeout = 600
client.PollingInterval = 100
| Option | Default value | Description |
|---|---|---|
| soft_id | 4583 | Your software ID obtained after publishing in 2captcha sofware catalog |
| callback | - | URL of your web-sever that receives the captcha recognition result. The URl should be first registered in pingback settings of your account |
| default_timeout | 120 | Timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from res.php API endpoint |
| recaptcha_timeout | 600 | Timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from res.php API endpoint |
| polling_interval | 10 | Interval in seconds between requests to res.php API endpoint, setting values less than 5 seconds is not recommended |
IMPORTANT: once callback URL is defined for
clientinstance, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL. To get the answer manually use GetResult method
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 captcha contains numeric or other symbols see more info in the API docs |
| min_len | 0 | minimal answer lenght |
| max_len | 0 | maximum answer length |
| phrase | 0 | defines if the answer contains multiple words or not |
| case_sensitive | 0 | defines if the answer is case sensitive |
| calc | 0 | defines captcha requires calculation |
| lang | - | defines the captcha language, see the list of supported languages |
| hint_img | - | an image with hint shown to workers with the captcha |
| hint_text | - | 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.
Example below shows a basic solver call example with error handling.
captcha := api2captcha.Normal{
File: "/path/to/normal.jpg",
}
code, err := client.Solve(captcha.ToRequest())
if err != nil {
if err == api2captcha.ErrTimeout {
log.Fatal("Timeout");
} else if err == api2captcha.ErrApi {
log.Fatal("API error");
} else if err == api2captcha.ErrNetwork {
log.Fatal("Network error");
} else {
log.Fatal(err);
}
}
fmt.Println("code "+code)
To bypass a normal captcha (distorted text on image) use the following method. This method also can be used to recognize any text on the image.
captcha:= api2captcha.Normal{
File: "/path/to/normal.jpg",
Numeric: 4,
MinLen: 4,
MaxLen: 20,
Phrase: true,
CaseSensitive: true,
Lang: "en",
HintImgFile: "/path/to/hint.jpg",
HintText: "Type red symbols",
}
This method can be used to bypass a captcha that requires to answer a question provided in clear text.
captcha:= api2captcha.Text{
Text: "If tomorrow is Saturday, what day is today?",
Lang: "en",
}
Use this method to solve ReCaptcha V2 and obtain a token to bypass the protection.
captcha := api2captcha.ReCaptcha{
SiteKey: "6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-",
Url: "https://mysite.com/page/with/recaptcha",
Invisible: true,
Action: "verify",
}
req := captcha.ToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
This method provides ReCaptcha V3 solver and returns a token.
captcha := api2captcha.ReCaptcha{
SiteKey: "6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-",
Url: "https://mysite.com/page/with/recaptcha",
Version: "v3",
Action: "verify",
Score: 0.3,
}
req := captcha.ToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
reCAPTCHA Enterprise can be used as reCAPTCHA V2 and reCAPTCHA V3. Below is a usage example for both versions.
// reCAPTCHA V2
captcha:= api2captcha.ReCaptcha({
SiteKey: "6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-",
Url: "https://mysite.com/page/with/recaptcha",
Invisible: true,
Action: "verify",
Enterprise: true,
})
// reCAPTCHA V3
captcha := api2captcha.ReCaptcha{
SiteKey: "6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-",
Url: "https://mysite.com/page/with/recaptcha",
Version: "v3",
Action: "verify",
Score: 0.3,
Enterprise: true,
}
req := captcha.ToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
FunCaptcha (Arkoselabs) solving method. Returns a token.
captcha := api2captcha.FunCaptcha{
SiteKey: "69A21A01-CC7B-B9C6-0F9A-E7FA06677FFC",
Url: "https://mysite.com/page/with/funcaptcha",
Surl: "https://client-api.arkoselabs.com",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36",
Data: map[string]string{"anyKey":"anyValue"},
}
req := captcha.ToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
captcha := api2captcha.GeeTest{
GT: "f2ae6cadcf7886856696502e1d55e00c",
ApiServer: "api-na.geetest.com",
Challenge: "12345678abc90123d45678ef90123a456b",
Url: "https://mysite.com/captcha.html",
}
req := captcha.ToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
captcha:= api2captcha.HCaptcha{
SiteKey: "10000000-ffff-ffff-ffff-000000000001",
Url: "https://mysite.com/captcha.html",
}
req := captchaToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
Token-based method to solve KeyCaptcha.
captcha:= api2captcha.KeyCaptcha{
UserId: 10,
SessionId: "493e52c37c10c2bcdf4a00cbc9ccd1e8",
WebServerSign: "9006dc725760858e4c0715b835472f22",
WebServerSign2: "9006dc725760858e4c0715b835472f22",
Url: "https://www.keycaptcha.ru/demo-magnetic/",
}
req := captchaToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
Token-based method to bypass Capy puzzle captcha.
captcha:= api2captcha.Capy{
SiteKey: "PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v",
Url: "https://www.mysite.com/captcha/",
}
req := captchaToRequest()
req.SetProxy("HTTPS", "login:password@IP_address:PORT")
code, err := client.Solve(req)
Grid method is originally called Old ReCaptcha V2 method. The method can be used to bypass any type of captcha where you can apply a grid on image and need to click specific grid boxes. Returns numbers of boxes.
captcha:= api2captcha.Grid{
File: "path/to/captcha.jpg",
Rows: 3,
Cols: 3,
PreviousId: 0,
CanSkip: false,
Lang: "en",
HintImageFile: "path/to/hint.jpg",
HintText: "Select all images with an Orange",
}
Canvas method can be used when you need to draw a line around an object on image. Returns a set of points' coordinates to draw a polygon.
captcha:= api2captcha.Canvas{
File: "path/to/captcha.jpg",
PreviousId: 0,
CanSkip: false,
Lang: "en",
HintImageFile: "path/to/hint.jpg",
HintText: "Draw around apple",
}
ClickCaptcha method returns coordinates of points on captcha image. Can be used if you need to click on particular points on the image.
captcha:= api2captcha.Coordinates{
File: "path/to/captcha.jpg",
Lang: "en",
HintImageFile: "path/to/hint.jpg",
HintText: "Connect the dots",
}
This method can be used to solve a captcha that asks to rotate an object. Mostly used to bypass FunCaptcha. Returns the rotation angle.
captcha:= api2captcha.Rotate{
File: "path/to/captcha.jpg",
Angle: 40,
Lang: "en",
HintImageFile: "path/to/hint.jpg",
HintText: "Put the images in the correct way",
}
Use this method to solve GeeTest v4. Returns the response in JSON.
captcha:= api2captcha.GeeTestV4{
CaptchaId: "e392e1d7fd421dc63325744d5a2b9c73",
Url: "https://www.site.com/page/",
}
Use this method to solve Lemin Captcha challenge. Returns JSON with answer containing the following values: answer, challenge_id.
captcha:= Lemin{
CaptchaId: "CROPPED_3dfdd5c_d1872b526b794d83ba3b365eb15a200b",
Url: "https://www.site.com/page/",
DivId: "lemin-cropped-captcha",
ApiServer: "api.leminnow.com",
}
Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
captcha:= api2captcha.CloudflareTurnstile{
SiteKey: "0x1AAAAAAAAkg0s2VIOD34y5",
Url: "http://mysite.com/",
}
Use this method to solve CyberSiARA and obtain a token to bypass the protection.
captcha:= api2captcha.CyberSiARA{
MasterUrlId: "12333-3123123",
Url: "https://test.com",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36",
}
Use this method to solve DataDome and obtain a token to bypass the protection. To solve the DataDome captcha, you must use a proxy.
captcha:= api2captcha.DataDome{
Url: "https://test.com",
CaptchaUrl: "https://test.com/captcha/",
Proxytype: "http",
Proxy: "proxyuser:strongPassword@123.123.123.123:3128",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61 Safari/537.36",
}
Use this method to solve MTCaptcha and obtain a token to bypass the protection.
captcha:= api2captcha.MTCaptcha{
Url: "https://service.mtcaptcha.com/mtcv1/demo/index.html",
SiteKey: "MTPublic-DemoKey9M",
}
Use this method to solve Yandex and obtain a token to bypass the protection.
captcha:= api2captcha.Yandex{
Url: "https://rutube.ru",
SiteKey: "Y5Lh0tiycconMJGsFd3EbbuNKSp1yaZESUOIHfeV",
}
Use this method to solve Friendly Captcha and obtain a token to bypass the protection.
captcha:= api2captcha.Friendly{
Url: "https://example.com",
SiteKey: "2FZFEVS1FZCGQ9",
}
Use this method to solve CutCaptcha and obtain a token to bypass the protection.
captcha:= api2captcha.CutCaptcha{
MiseryKey: "a1488b66da00bf332a1488993a5443c79047e752",
DataApiKey: "SAb83IIB",
Url: "https://example.cc/foo/bar.html",
}
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.
captcha:= api2captcha.AmazonWAF {
Iv: "CgAHbCe2GgAAAAAj",
SiteKey: "0x1AAAAAAAAkg0s2VIOD34y5",
Url: "https://non-existent-example.execute-api.us-east-1.amazonaws.com/latest",
Context: "9BUgmlm48F92WUoqv97a49ZuEJJ50TCk9MVr3C7WMtQ0X6flVbufM4n8mjFLmbLVAPgaQ1Jydeaja94iAS49ljb",
ChallengeScript: "https://41bcdd4fb3cb.610cd090.us-east-1.token.awswaf.com/41bcdd4fb3cb/0d21de737ccb/cd77baa6c832/challenge.js"
CaptchaScript: "https://41bcdd4fb3cb.610cd090.us-east-1.captcha.awswaf.com/41bcdd4fb3cb/0d21de737ccb/cd77baa6c832/captcha.js"
}
These methods can be used for manual captcha submission and answer polling.
id, err := client.Send(captchaToRequest())
if err != nil {
log.Fatal(err);
}
time.Sleep(10 * time.Second)
code, err := client.GetResult(id)
if err != nil {
log.Fatal(err);
}
if code == nil {
log.Fatal("Not ready")
}
fmt.Println("code "+*code)
Use this method to get your account's balance
balance, err := client.GetBalance()
if err != nil {
log.Fatal(err);
}
Use this method to report good or bad captcha answer.
err := client.Report(id, true) // solved correctly
err := client.Report(id, false) // solved incorrectly
You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, keycaptcha, capy puzzle, lemin, turnstile, amazon waf, CyberSiARA, DataDome, MTCaptcha 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.
There are many ways to contribute, of which development is only one! Find your next job. Open positions: AI experts, scrapers, developers, technical support, and much more! 😍
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.