Skip to main content

Module requests

Module requests 

Source
Expand description

One struct per captcha type. Every struct implements CaptchaRequest.

Conventions used by all request types (keep them when adding a new one):

  • Type::new(<required fields>) builds a request; optional fields are Option<_> public fields with chainable with_<field>(value) setters.
  • Field names are snake_case; #[serde(rename = "...")] maps them to the exact API names (note websiteURL, not websiteUrl). None fields are not sent.
  • "type" (and "class" for CustomTask) come from TASK_TYPE / CLASS, never from a field.
  • Local checks that the API would reject anyway live in validate().

Structs§

AlibabaCustomTaskRequest
Alibaba CAPTCHA / WAF (CustomTask, class alibaba).
AlibabaMetadata
Alibaba captcha parameters. Only scene_id and prefix are always required; set the other ones only if the target website uses them.
AltchaCustomTaskRequest
Altcha proof-of-work captcha (CustomTask, class altcha).
AltchaMetadata
Altcha challenge parameters taken from the page (all four are required by the API).
AmazonChallengeAndCaptcha
Option 2: challenge plus captcha. The values come from window.gokuProps (key, context, iv) on the 405 page of the protected site.
AmazonChallengeOnly
Option 3: invisible captcha, only challenge.js is loaded. context and iv are sent as empty strings, as the API requires.
AmazonVisibleCaptcha
Option 1: visible AWS WAF captcha (jsapi.js / captcha.js only).
AmazonWafRequest
Amazon AWS WAF captcha and challenge (AmazonTask).
BasiliskCustomTaskRequest
Basilisk captcha (CustomTask, class Basilisk).
BinanceTaskRequest
Binance custom captcha (BinanceTask). Use only to log in with your own account.
DataDomeCustomTaskRequest
DataDome captcha (CustomTask, class DataDome). Your own proxy is required. If the proxy uses IP authorization, whitelist 65.21.190.34. The solution contains cookies that must be set in the browser.
DataDomeMetadata
DataDome-specific challenge data. All values are dynamic: extract them right before creating the task.
EnterprisePayload
Additional reCAPTCHA Enterprise parameters (enterprisePayload object).
FriendlyCustomTaskRequest
Friendly Captcha (CustomTask, class friendly).
FriendlyMetadata
Friendly Captcha parameters.
FuncaptchaRequest
FunCaptcha / Arkose Labs (FunCaptchaTask).
GeetestRequest
GeeTest captcha (GeeTestTask), versions 3 and 4.
HuntCustomTaskRequest
HUNT captcha (CustomTask, class HUNT). Your own proxy is required.
HuntMetadata
HUNT parameters. Values are dynamic: extract them right before creating the task.
ImageToTextRequest
Text-on-image captcha (ImageToTextTask).
ImpervaCustomTaskRequest
Imperva / Incapsula (CustomTask, class Imperva). Your own proxy is required.
ImpervaMetadata
Imperva (Incapsula) challenge data. Values are dynamic: extract them right before creating the task.
MtCaptchaRequest
MTCaptcha (MTCaptchaTask).
ProsopoTaskRequest
Prosopo Procaptcha (ProsopoTask), token based.
RecaptchaComplexImageTaskRequest
reCAPTCHA v2 image click task (ComplexImageTask, class recaptcha). No proxy is needed.
RecaptchaMetadata
metadata of the reCAPTCHA click task.
RecaptchaV2EnterpriseRequest
reCAPTCHA v2 Enterprise (RecaptchaV2EnterpriseTask).
RecaptchaV2Request
reCAPTCHA v2 (RecaptchaV2Task). Without proxy the task is solved from CapMonster’s own IPs.
RecaptchaV3EnterpriseRequest
reCAPTCHA v3 Enterprise (RecaptchaV3EnterpriseTask). Proxies are not supported.
RecaptchaV3ProxylessRequest
reCAPTCHA v3 (RecaptchaV3TaskProxyless). Proxies are not supported.
RecognitionComplexImageTaskRequest
Recognition modules of ComplexImageTask (class recognition), no proxy needed.
RecognitionMetadata
metadata of a recognition task.
TenDiCustomTaskRequest
TenDI / Tencent captcha (CustomTask, class TenDI).
TenDiMetadata
Optional TenDI (Tencent captcha) parameters.
TspdCustomTaskRequest
TSPD (CustomTask, class tspd). Your own proxy is required.
TspdMetadata
TSPD challenge data. Values are dynamic: extract them right before creating the task.
TurnstileChallengeCookie
Cloudflare Challenge solved to the cf_clearance cookie (cloudflareTaskType = "cf_clearance"). Your own proxy is mandatory.
TurnstileChallengeToken
Cloudflare Challenge solved to a token (cloudflareTaskType = "token").
TurnstileRequest
Cloudflare Turnstile / Challenge / Waiting Room (TurnstileTask).
TurnstileStandard
Regular Cloudflare Turnstile widget (no cloudflareTaskType). All subtypes (manual, non-interactive, invisible) are supported automatically. The result is a token.
TurnstileWaitRoom
Cloudflare Waiting Room (cloudflareTaskType = "wait_room"); the result is cookies. Your own proxy is mandatory.
YidunRequest
NetEase Yidun captcha (YidunTask). Setting challenge selects the Enterprise variant.

Enums§

AmazonWafVariant
The three mutually exclusive parameter sets accepted by the API for AmazonTask.
DataDomeVersion
DataDome solving method version (datadomeVersion).
GeetestVersion
GeeTest version together with the parameters that only exist for that version.
HuntMode
What the HUNT solver should do. data and widgetUrl are mutually exclusive.
PayloadType
Kind of data sent in imagesBase64 (PayloadType inside metadata).
RecaptchaGrid
Image grid size of a reCAPTCHA challenge (Grid inside metadata).
TextModule
Recognition modules accepted by ImageToTextTask (capMonsterModule), as listed in https://docs.capmonster.cloud/docs/captchas/ImageToText/module-name.txt. A module missing here (the list grows) can be passed with TextModule::Custom.
TurnstileMode
What kind of Cloudflare protection is being solved.

Traits§

CaptchaRequest
A task that can be sent to CapMonster Cloud.