Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

captcha

package

Go to main page

Versions in this module

v1

v1.9.0

Sep 29, 2026

v1.8.2

Sep 26, 2026

v1.8.1

Sep 26, 2026

v1.8.0

Sep 24, 2026

v1.7.0

Sep 22, 2026

v1.6.1

Sep 8, 2026

v1.6.0

Sep 4, 2026

v1.5.4

Aug 31, 2026

Changes in this version

+ var ErrMockSolveFailed = errors.New("captcha: mock solve failed")

+ var ErrPluginNotRegistered = errors.New("captcha: plugin not registered. Call app.Use(captcha.New())")

+ func Bindings(c *container.Container, m *Manager)

+ func GetBalance(ctx context.Context) (float64, error)

+ func Protect() router.Middleware

+ func ProtectWithOptions(opts MiddlewareOptions) router.Middleware

+ type BalanceResponse struct

+ Balance float64

+ ErrorCode string

+ ErrorDescription string

+ ErrorId int

+ type Client struct

+ func NewClient(cfg *Config) (*Client, error)

+ func (c *Client) CreateTask(ctx context.Context, payload TaskPayload) (*CreateTaskResponse, error)

+ func (c *Client) GetBalance(ctx context.Context) (float64, error)

+ func (c *Client) GetTaskResult(ctx context.Context, taskID string) (*GetTaskResultResponse, error)

+ func (c *Client) Solve(ctx context.Context, payload TaskPayload) (*Solution, error)

+ type Config struct

+ APIKey string

+ DefaultProvider string

+ Endpoint string

+ MaxRetries int

+ MockMode bool

+ PollingInterval time.Duration

+ ProviderSecretKeys map[string]string

+ Timeout time.Duration

+ func DefaultConfig() *Config

+ type CreateTaskRequest struct

+ AppID string

+ ClientKey string

+ Task TaskPayload

+ type CreateTaskResponse struct

+ ErrorCode string

+ ErrorDescription string

+ ErrorId int

+ Status string

+ TaskID string

+ func CreateTask(ctx context.Context, payload TaskPayload) (*CreateTaskResponse, error)

+ type GetTaskResultRequest struct

+ ClientKey string

+ TaskID string

+ type GetTaskResultResponse struct

+ ErrorCode string

+ ErrorDescription string

+ ErrorId int

+ Solution Solution

+ Status string

+ func GetTaskResult(ctx context.Context, taskID string) (*GetTaskResultResponse, error)

+ type Manager struct

+ Client *Client

+ Verifier *Verifier

+ func GetManager() *Manager

+ func NewManager(cfg *Config) (*Manager, error)

+ type MiddlewareOptions struct

+ Provider string

+ TokenFormField string

+ TokenHeader string

+ func DefaultMiddlewareOptions() MiddlewareOptions

+ type MockSolver struct

+ MockToken string

+ ShouldFail bool

+ func NewMockSolver() *MockSolver

+ func (m *MockSolver) Solve(ctx context.Context, payload TaskPayload) (*Solution, error)

+ type Plugin struct

+ func New(cfg ...*Config) *Plugin

+ func (p *Plugin) Bindings(c *container.Container)

+ func (p *Plugin) Boot(app *nimbus.App) error

+ func (p *Plugin) DefaultConfig() map[string]any

+ func (p *Plugin) Middleware() map[string]router.Middleware

+ func (p *Plugin) Register(app *nimbus.App) error

+ type Solution struct

+ Extra map[string]any

+ GRecaptchaResponse string

+ RespKey string

+ SolveTime time.Duration

+ Text string

+ Token string

+ UserAgent string

+ func Solve(ctx context.Context, payload TaskPayload) (*Solution, error)

+ type TaskPayload struct

+ Body string

+ ExtraParams map[string]string

+ MetaData map[string]any

+ MinScore float64

+ PageAction string

+ Proxy string

+ Type TaskType

+ UserAgent string

+ WebsiteKey string

+ WebsiteURL string

+ type TaskType string

+ const TaskTypeAmazonWAF

+ const TaskTypeGeeTest

+ const TaskTypeHCaptcha

+ const TaskTypeHCaptchaProxyless

+ const TaskTypeImageToText

+ const TaskTypeReCaptchaEnterprise

+ const TaskTypeReCaptchaV2

+ const TaskTypeReCaptchaV2Proxyless

+ const TaskTypeReCaptchaV3

+ const TaskTypeReCaptchaV3Proxyless

+ const TaskTypeTurnstile

+ const TaskTypeTurnstileProxyless

+ type VerificationResult struct

+ Action string

+ ChallengeTS time.Time

+ ErrorCodes []string

+ Hostname string

+ Score float64

+ Success bool

+ func Verify(ctx context.Context, provider, token, remoteIP string) (*VerificationResult, error)

+ type Verifier struct

+ func NewVerifier(cfg *Config) *Verifier

+ func (v *Verifier) VerifyToken(ctx context.Context, provider, token, remoteIP string) (*VerificationResult, error)