api2captcha

package module
v1.1.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2024 License: MIT Imports: 11 Imported by: 7

README

Golang Module for 2Captcha API

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.

Installation

To install the api client, use this:

go get -u github.com/2captcha/2captcha-go

Configuration

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
Client instance options
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 client instance, 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

Solve captcha

When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.

Captcha options
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.

Basic example

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)
Normal Captcha

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",
}
Text Captcha

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",
}
ReCaptcha v2

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)
ReCaptcha v3

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

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

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)
GeeTest

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)
hCaptcha

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)
KeyCaptcha

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)
Capy

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

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

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

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",
}
Rotate

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",
}
GeeTestV4

Use this method to solve GeeTest v4. Returns the response in JSON.

captcha:= api2captcha.GeeTestV4{
    CaptchaId: "e392e1d7fd421dc63325744d5a2b9c73",
    Url: "https://www.site.com/page/",
}
Lemin Cropped Captcha

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",
}
Cloudflare Turnstile

Use this method to solve Cloudflare Turnstile. Returns JSON with the token.

captcha:= api2captcha.CloudflareTurnstile{
   SiteKey: "0x1AAAAAAAAkg0s2VIOD34y5",
   Url: "http://mysite.com/",
}
CyberSiARA

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",
}
DataDome

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",
}
MTCaptcha

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",
}
Yandex

Use this method to solve Yandex and obtain a token to bypass the protection.

captcha:= api2captcha.Yandex{
  Url: "https://rutube.ru",
  SiteKey: "Y5Lh0tiycconMJGsFd3EbbuNKSp1yaZESUOIHfeV",
}
Friendly Captcha

Use this method to solve Friendly Captcha and obtain a token to bypass the protection.

captcha:= api2captcha.Friendly{
  Url: "https://example.com",
  SiteKey: "2FZFEVS1FZCGQ9",
}
CutCaptcha

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",
}
Amazon WAF

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"
}

Other methods

Send / GetResult

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)
balance

Use this method to get your account's balance

balance, err := client.GetBalance()
if err != nil {
   log.Fatal(err);
}
report

Use this method to report good or bad captcha answer.

err := client.Report(id, true) // solved correctly
err := client.Report(id, false) // solved incorrectly

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, 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.

Get in touch

Join the team 👪

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! 😍

Documentation

Index

Constants

View Source 
const (
	BaseURL       = "https://2captcha.com"
	DefaultSoftId = 4583
)

Variables

View Source 
var (
	ErrNetwork = errors.New("api2captcha: Network failure")
	ErrApi     = errors.New("api2captcha: API error")
	ErrTimeout = errors.New("api2captcha: Request timeout")
)

Functions

This section is empty.

Types

type AmazonWAF 

type AmazonWAF struct {
	Iv              string
	SiteKey         string
	Url             string
	Context         string
	ChallengeScript string
	CaptchaScript   string
}

func (*AmazonWAF) ToRequest 

func (c *AmazonWAF) ToRequest() Request

type Canvas 

type Canvas struct {
	File            string
	Base64          string
	PreviousId      int
	CanSkip         bool
	Lang            string
	HintText        string
	HintImageBase64 string
	HintImageFile   string
}

func (*Canvas) ToRequest 

func (c *Canvas) ToRequest() Request

type Capy 

type Capy struct {
	SiteKey   string
	Url       string
	ApiServer string
}

func (*Capy) ToRequest 

func (c *Capy) ToRequest() Request

type Client 

type Client struct {
	BaseURL          *url.URL
	ApiKey           string
	SoftId           int
	Callback         string
	DefaultTimeout   int
	RecaptchaTimeout int
	PollingInterval  int
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(apiKey string) *Client

func NewClientExt 

func NewClientExt(apiKey string, client *http.Client) *Client

func (*Client) GetBalance 

func (c *Client) GetBalance() (float64, error)

func (*Client) GetResult 

func (c *Client) GetResult(id string) (*string, error)

func (*Client) Report 

func (c *Client) Report(id string, correct bool) error

func (*Client) Send 

func (c *Client) Send(req Request) (string, error)

func (*Client) Solve 

func (c *Client) Solve(req Request) (string, string, error)

func (*Client) WaitForResult 

func (c *Client) WaitForResult(id string, timeout int, interval int) (string, error)

type CloudflareTurnstile 

type CloudflareTurnstile struct {
	SiteKey   string
	Url       string
	Data      string
	PageData  string
	Action    string
	UserAgent string
}

func (*CloudflareTurnstile) ToRequest 

func (c *CloudflareTurnstile) ToRequest() Request

type Coordinates 

type Coordinates struct {
	File            string
	Base64          string
	Lang            string
	HintText        string
	HintImageBase64 string
	HintImageFile   string
}

func (*Coordinates) ToRequest 

func (c *Coordinates) ToRequest() Request

type CutCaptcha 

type CutCaptcha struct {
	MiseryKey  string
	DataApiKey string
	Url        string
}

func (*CutCaptcha) ToRequest 

func (c *CutCaptcha) ToRequest() Request

type CyberSiARA 

type CyberSiARA struct {
	MasterUrlId string
	Url         string
	UserAgent   string
}

func (*CyberSiARA) ToRequest 

func (c *CyberSiARA) ToRequest() Request

type DataDome 

type DataDome struct {
	Url        string
	CaptchaUrl string
	Proxytype  string
	Proxy      string
	UserAgent  string
}

func (*DataDome) ToRequest 

func (c *DataDome) ToRequest() Request

type Friendly 

type Friendly struct {
	Url     string
	SiteKey string
}

func (*Friendly) ToRequest 

func (c *Friendly) ToRequest() Request

type FunCaptcha 

type FunCaptcha struct {
	SiteKey   string
	Url       string
	Surl      string
	UserAgent string
	Data      map[string]string
}

func (*FunCaptcha) ToRequest 

func (c *FunCaptcha) ToRequest() Request

type GeeTest 

type GeeTest struct {
	GT        string
	Challenge string
	Url       string
	ApiServer string
}

func (*GeeTest) ToRequest 

func (c *GeeTest) ToRequest() Request

type GeeTestV4 

type GeeTestV4 struct {
	CaptchaId string
	Url       string
}

func (*GeeTestV4) ToRequest 

func (c *GeeTestV4) ToRequest() Request

type Grid 

type Grid struct {
	File            string
	Base64          string
	Rows            int
	Cols            int
	PreviousId      int
	CanSkip         bool
	Lang            string
	HintText        string
	HintImageBase64 string
	HintImageFile   string
}

func (*Grid) ToRequest 

func (c *Grid) ToRequest() Request

type HCaptcha 

type HCaptcha struct {
	SiteKey string
	Url     string
}

func (*HCaptcha) ToRequest 

func (c *HCaptcha) ToRequest() Request

type KeyCaptcha 

type KeyCaptcha struct {
	UserId         int
	SessionId      string
	WebServerSign  string
	WebServerSign2 string
	Url            string
}

func (*KeyCaptcha) ToRequest 

func (c *KeyCaptcha) ToRequest() Request

type Lemin 

type Lemin struct {
	CaptchaId string
	DivId     string
	Url       string
	ApiServer string
}

func (*Lemin) ToRequest 

func (c *Lemin) ToRequest() Request

type MTCaptcha 

type MTCaptcha struct {
	SiteKey string
	Url     string
}

func (*MTCaptcha) ToRequest 

func (c *MTCaptcha) ToRequest() Request

type Normal 

type Normal struct {
	File            string
	Base64          string
	Phrase          bool
	CaseSensitive   bool
	Calc            bool
	Numberic        int
	MinLen          int
	MaxLen          int
	Lang            string
	HintText        string
	HintImageBase64 string
	HintImageFile   string
}

func (*Normal) ToRequest 

func (c *Normal) ToRequest() Request

type ReCaptcha 

type ReCaptcha struct {
	SiteKey    string
	Url        string
	Invisible  bool
	Enterprise bool
	Version    string
	Action     string
	DataS      string
	Score      float64
}

func (*ReCaptcha) ToRequest 

func (c *ReCaptcha) ToRequest() Request

type Request 

type Request struct {
	Params map[string]string
	Files  map[string]string
}

func (*Request) SetCallback 

func (req *Request) SetCallback(callback string)

func (*Request) SetProxy 

func (req *Request) SetProxy(proxyType string, uri string)

func (*Request) SetSoftId 

func (req *Request) SetSoftId(softId int)

type Rotate 

type Rotate struct {
	File            string
	Files           []string
	Angle           int
	Lang            string
	HintText        string
	HintImageBase64 string
	HintImageFile   string
}

func (*Rotate) ToRequest 

func (c *Rotate) ToRequest() Request

type Text 

type Text struct {
	Text string
	Lang string
}

func (*Text) ToRequest 

func (c *Text) ToRequest() Request

type Yandex 

type Yandex struct {
	Url     string
	SiteKey string
}

func (*Yandex) ToRequest 

func (c *Yandex) ToRequest() Request

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.