Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Type

Required

Value

type

String

Yes

HCaptchaTask

websiteURL

String

Yes

Address of a webpage with hCaptcha

websiteKey

String

Yes

hCaptcha website key.

isInvisible

Bool

No

Use true for invisible version of hcaptcha

data

String

No

Custom data that is used in some implementations of hCaptcha, mostly with isInvisible=true. In most cases you see it as rqdata inside network requests.
IMPORTANT: you MUST provide userAgent if you submit captcha with data parameter. The value should match the User-Agent you use when interacting with the target website.
Pass only the actual UA from Windows OS. Now this is version 119120: “Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119120.0.0.0 Safari/537.36”

proxyType

String

Yes

Type of the proxy

http - usual http/https proxy
https - try this only if "http" doesn't work (required by some custom proxy servers)
socks4 - socks4 proxy
socks5 - socks5 proxy

proxyAddress

String

Yes

Proxy IP address IPv4/IPv6. Not allowed to use:

  • host names instead of IPs

  • transparent proxies (where client IP is visible)

  • proxies from local networks (192.., 10.., 127...)

proxyPort

Integer

Yes

Proxy port

proxyLogin

String

No

Login for proxy which requires authorizaiton (basic)

proxyPassword

String

No

Proxy password

userAgent

String

No

The browser User-Agent used in the emulation. You must use a modern browser signature or Google will return an error asking you to update your browser.
Pass only the actual UA from Windows OS. Now this is version 119120: “Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119120.0.0.0 Safari/537.36”

cookies

String

No

Additional cookies which we must use during interaction with target page.

Format: cookiename1=cookievalue1; cookiename2=cookievalue2

fallbackToActualUA

Bool

No

true - when specifying this parameter, we ignore the irrelevant User Agent that users send in the request, and return our own (relevant) one with getTaskResult. This will improve the acceptance of tokens.

false - we insert the User Agent that is specified in the request. If the User Agent is invalid, you will receive an error ERROR_WRONG_USERAGENT (USERAGENT IS EXPIRED in the log).

...