Skip to content

Commit c5dffd7

Browse files
Documentation
1 parent c5478df commit c5dffd7

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ Full sample: [example.Normal_Captcha.py](https://github.com/deathbycaptcha/death
278278
captcha = client.decode("images/normal.jpg", timeout=120)
279279
```
280280

281+
---
282+
281283
<a id="sample-type-4-recaptcha-v2-token"></a>
282284
#### 🤖 Sample Type 4: reCAPTCHA v2 Token
283285
Official description: [reCAPTCHA Token API (v2)](https://deathbycaptcha.com/api/newtokenrecaptcha#token-v2)
@@ -297,6 +299,8 @@ token_params = json.dumps(
297299
captcha = client.decode(type=4, token_params=token_params)
298300
```
299301

302+
---
303+
300304
<a id="sample-type-5-recaptcha-v3-token"></a>
301305
#### 🤖 Sample Type 5: reCAPTCHA v3 Token
302306
Official description: [reCAPTCHA v3](https://deathbycaptcha.com/api/newtokenrecaptcha#reCAPTCHAv3)
@@ -318,6 +322,8 @@ token_params = json.dumps(
318322
captcha = client.decode(type=5, token_params=token_params)
319323
```
320324

325+
---
326+
321327
<a id="sample-type-25-recaptcha-v2-enterprise"></a>
322328
#### 🏢 Sample Type 25: reCAPTCHA v2 Enterprise
323329
Official description: [reCAPTCHA v2 Enterprise](https://deathbycaptcha.com/api/newtokenrecaptcha#reCAPTCHAv2Enterprise)
@@ -337,6 +343,8 @@ token_enterprise_params = json.dumps(
337343
captcha = client.decode(type=25, token_enterprise_params=token_enterprise_params)
338344
```
339345

346+
---
347+
340348
<a id="sample-type-8-geetest-v3"></a>
341349
#### 🧩 Sample Type 8: GeeTest v3
342350
Official description: [GeeTest](https://deathbycaptcha.com/api/geetest)
@@ -357,6 +365,8 @@ geetest_params = json.dumps(
357365
captcha = client.decode(type=8, geetest_params=geetest_params)
358366
```
359367

368+
---
369+
360370
<a id="sample-type-9-geetest-v4"></a>
361371
#### 🧩 Sample Type 9: GeeTest v4
362372
Official description: [GeeTest](https://deathbycaptcha.com/api/geetest)
@@ -376,6 +386,8 @@ geetest_params = json.dumps(
376386
captcha = client.decode(type=9, geetest_params=geetest_params)
377387
```
378388

389+
---
390+
379391
<a id="sample-type-11-text-captcha"></a>
380392
#### 💬 Sample Type 11: Text CAPTCHA
381393
Official description: [Text CAPTCHA](https://deathbycaptcha.com/api/textcaptcha)
@@ -385,6 +397,8 @@ Full sample: [example.Textcaptcha.py](https://github.com/deathbycaptcha/deathbyc
385397
captcha = client.decode(type=11, textcaptcha="What is two plus two?")
386398
```
387399

400+
---
401+
388402
<a id="sample-type-12-cloudflare-turnstile"></a>
389403
#### ☁️ Sample Type 12: Cloudflare Turnstile
390404
Official description: [Cloudflare Turnstile](https://deathbycaptcha.com/api/turnstile)
@@ -404,6 +418,8 @@ turnstile_params = json.dumps(
404418
captcha = client.decode(type=12, turnstile_params=turnstile_params)
405419
```
406420

421+
---
422+
407423
<a id="sample-type-13-audio-captcha"></a>
408424
#### 🔊 Sample Type 13: Audio CAPTCHA
409425
Official description: [Audio CAPTCHA](https://deathbycaptcha.com/api/audio)
@@ -417,6 +433,8 @@ with open("images/audio.mp3", "rb") as f:
417433
captcha = client.decode(type=13, audio=audio_b64, language="en")
418434
```
419435

436+
---
437+
420438
<a id="sample-type-14-lemin"></a>
421439
#### 🔵 Sample Type 14: Lemin
422440
Official description: [Lemin](https://deathbycaptcha.com/api/lemin)
@@ -436,6 +454,8 @@ lemin_params = json.dumps(
436454
captcha = client.decode(type=14, lemin_params=lemin_params)
437455
```
438456

457+
---
458+
439459
<a id="sample-type-15-capy"></a>
440460
#### 🏴 Sample Type 15: Capy
441461
Official description: [Capy](https://deathbycaptcha.com/api/capy)
@@ -456,6 +476,8 @@ capy_params = json.dumps(
456476
captcha = client.decode(type=15, capy_params=capy_params)
457477
```
458478

479+
---
480+
459481
<a id="sample-type-16-amazon-waf"></a>
460482
#### 🛡️ Sample Type 16: Amazon WAF
461483
Official description: [Amazon WAF](https://deathbycaptcha.com/api/amazonwaf)
@@ -477,6 +499,8 @@ waf_params = json.dumps(
477499
captcha = client.decode(type=16, waf_params=waf_params)
478500
```
479501

502+
---
503+
480504
<a id="sample-type-17-siara"></a>
481505
#### 🔍 Sample Type 17: Siara
482506
Official description: [Siara](https://deathbycaptcha.com/api/siara)
@@ -497,6 +521,8 @@ siara_params = json.dumps(
497521
captcha = client.decode(type=17, siara_params=siara_params)
498522
```
499523

524+
---
525+
500526
<a id="sample-type-18-mtcaptcha"></a>
501527
#### 🔒 Sample Type 18: MTCaptcha
502528
Official description: [MTCaptcha](https://deathbycaptcha.com/api/mtcaptcha)
@@ -516,6 +542,8 @@ mtcaptcha_params = json.dumps(
516542
captcha = client.decode(type=18, mtcaptcha_params=mtcaptcha_params)
517543
```
518544

545+
---
546+
519547
<a id="sample-type-19-cutcaptcha"></a>
520548
#### ✂️ Sample Type 19: Cutcaptcha
521549
Official description: [Cutcaptcha](https://deathbycaptcha.com/api/cutcaptcha)
@@ -536,6 +564,8 @@ cutcaptcha_params = json.dumps(
536564
captcha = client.decode(type=19, cutcaptcha_params=cutcaptcha_params)
537565
```
538566

567+
---
568+
539569
<a id="sample-type-20-friendly-captcha"></a>
540570
#### 💚 Sample Type 20: Friendly Captcha
541571
Official description: [Friendly Captcha](https://deathbycaptcha.com/api/friendly)
@@ -555,6 +585,8 @@ friendly_params = json.dumps(
555585
captcha = client.decode(type=20, friendly_params=friendly_params)
556586
```
557587

588+
---
589+
558590
<a id="sample-type-21-datadome"></a>
559591
#### 🛡️ Sample Type 21: DataDome
560592
Official description: [DataDome](https://deathbycaptcha.com/api/datadome)
@@ -574,6 +606,8 @@ datadome_params = json.dumps(
574606
captcha = client.decode(type=21, datadome_params=datadome_params)
575607
```
576608

609+
---
610+
577611
<a id="sample-type-23-tencent"></a>
578612
#### 🇨🇳 Sample Type 23: Tencent
579613
Official description: [Tencent](https://deathbycaptcha.com/api/tencent)
@@ -593,6 +627,8 @@ tencent_params = json.dumps(
593627
captcha = client.decode(type=23, tencent_params=tencent_params)
594628
```
595629

630+
---
631+
596632
<a id="sample-type-24-atb"></a>
597633
#### 🏷️ Sample Type 24: ATB
598634
Official description: [ATB](https://deathbycaptcha.com/api/atb)
@@ -641,16 +677,24 @@ python python_selenium_example.py
641677

642678
See detailed usage in [examples/deathbycaptcha-python-selenium/README.md](examples/deathbycaptcha-python-selenium/README.md).
643679

680+
---
681+
644682
<a id="recaptcha-image-based-api"></a>
645683
### ⛔ reCAPTCHA Image-Based API — Deprecated (Types 2 & 3)
646684

647685
> ⚠️ **Deprecated.** Types 2 (Coordinates) and 3 (Image Group) are legacy image-based reCAPTCHA challenge methods that are no longer used at captcha solving. Do not use them for new integrations — use the [reCAPTCHA Token API (v2 & v3)](#recaptcha-token-api) instead.
686+
687+
---
688+
648689
<a id="recaptcha-token-api"></a>
649690
### 🔐 reCAPTCHA Token API (v2 & v3)
650691

651692
The Token-based API solves reCAPTCHA challenges by returning a token you inject directly into the page form, rather than clicking images. Given a site URL and site key, DBC solves the challenge on its side and returns a token valid for one submission.
652693

653694
- **Token Image API**: Provided a site URL and site key, the API returns a token that you use to submit the form on the page with the reCAPTCHA challenge.
695+
696+
---
697+
654698
<a id="recaptcha-v2-api-faq"></a>
655699
### ❓ reCAPTCHA v2 API FAQ
656700

@@ -699,11 +743,17 @@ The token image API response has the same structure as regular captchas' respons
699743
```bash
700744
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrdsaD2H0e6S3547xi1FlqJB4rob46J0-wfZMj6YpyVa0WGCfpWzBWcLn7tO_EYsvEC_3kfLNINWa5LnKrnJTDXTOz-JuCKvEXx0EQqzb0OU4z2np4uyu79lc_NdvL0IRFc3Cslu6UFV04CIfqXJBWCE5MY0Ag918r14b43ZdpwHSaVVrUqzCQMCybcGq0yxLQf9eSexFiAWmcWLI5nVNA81meTXhQlyCn5bbbI2IMSEErDqceZjf1mX3M67BhIb4"
701745
```
746+
747+
---
748+
702749
<a id="what-is-recaptcha-v3"></a>
703750
### 🔎 What is reCAPTCHA v3?
704751
This API extends the reCAPTCHA v2 Token API with two additional parameters: `action` and **minimal score (`min_score`)**.
705752
reCAPTCHA v3 returns a score from each user, that evaluate if user is a bot or human. Then the website uses the score value that could range from 0 to 1 to decide if will accept or not the requests. Lower scores near to 0 are identified as bot.
706753
The `action` parameter at reCAPTCHA v3 is an additional data used to separate different captcha validations like for example **login**, **register**, **sales**, **etc**.
754+
755+
---
756+
707757
<a id="recaptcha-v3-api-faq"></a>
708758
### ❓ reCAPTCHA v3 API FAQ
709759

@@ -754,6 +804,8 @@ Full example of **`token_params`**:
754804
**What's the response from reCAPTCHA v3 API?**
755805
The response has the same structure as regular captcha. Refer to [Polling for uploaded CAPTCHA status](https://deathbycaptcha.com/api#polling-captcha) for details about the response. The solution will come in the **text** key of the response. It's valid for one use and has a 1 minute lifespan.
756806

807+
---
808+
757809
<a id="amazon-waf-api-faq"></a>
758810
### 🛡️ Amazon WAF API (Type 16)
759811

@@ -821,6 +873,8 @@ With optional `challengejs` and `captchajs`:
821873
c3b50e60-d76c-4d13-ae25-159ec7ec3121:EQoAj4x6fnENAAAA:YIvITdQewAaLmaLXo4r6Es783keXM2ahoP...
822874
```
823875

876+
---
877+
824878
<a id="cloudflare-turnstile-api-faq"></a>
825879
### 🌐 Cloudflare Turnstile API (Type 12)
826880

0 commit comments

Comments
 (0)