🧩Parameters
This is a general overview of the parameters found throughout the captcha documentation.
Some tasks have custom values which can be found in this specific task page.
Parameters
clientKey
string
true
Your accounts private API Key.
callbackUrl
string
false
Optional callback url for solution results.
type
array
true
RecaptchaV2Task
type.websiteURL
string
true
The website address in which you're solving the captcha for.
type.websiteKey
string
true
The websites site key.
type.recaptchaDataSValue
string
false
Certain custom implementations of Recaptcha may require an s-data value to solve. This can be found in the s-data attribute of the recaptcha div in the page source.
type.userAgent
string
false
Browser user-agent used in emulation. Must use modern browser user-agent to avoid google prompting to "Update your browser".
type.cookies
array
false
Array of cookies to be sent.
type.cookies.name
string
false
The cookie name.
type.cookies.value
string
false
The cookie value.
type.isInvisible
bool
false
If the captcha field is visible set to true, if the captcha field is NOT visible or has a hidden field for confirmation this value must be set to false.
type.minScore
string
false
Value from 0.1 to 0.9 which represents the score of the solution results. Higher score may yield better results on certain sites.
type.pageAction
string
false
Can be found as value of sa parameter in the anchor endpoint or found in recaptcha widget as the action value. Typically a static value.
type.enterprisePayload.s
string
false
Contains the parameter s, for custom implementations of ReCaptcha that require the s data. This can be found either in the page source or in the recaptcha network activity. This value alternates therefor must be scraped and used anew on each solve.
type.proxyType
string
true
The type of proxy. Accepts values: http, https, socks4, and socks5.
type.proxyAddress
string
true
The IPv4/IPv6 IP for your proxy (Host names, non-transparent, and local network proxies are not allowed).
type.proxyPort
int
true
The proxy port.
type.proxyLogin
string
false
The proxy username.
type.proxyPassword
string
false
The proxy password.
Last updated