Skip to content

Commit 09d8372

Browse files
Documentation updates
1 parent 781d767 commit 09d8372

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,7 @@ Minimal usage snippet for each supported type. Use these as a starting point and
272272
<a id="sample-type-0-standard-image"></a>
273273
#### 🖼️ Sample Type 0: Standard Image
274274
Official description: [Supported CAPTCHAs](https://deathbycaptcha.com/api#supported_captchas)
275+
Full sample: [example.Normal_Captcha.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Normal_Captcha.py)
275276

276277
```python
277278
captcha = client.decode("images/normal.jpg", timeout=120)
@@ -280,6 +281,7 @@ captcha = client.decode("images/normal.jpg", timeout=120)
280281
<a id="sample-type-4-recaptcha-v2-token"></a>
281282
#### 🤖 Sample Type 4: reCAPTCHA v2 Token
282283
Official description: [reCAPTCHA Token API (v2)](https://deathbycaptcha.com/api/newtokenrecaptcha#token-v2)
284+
Full sample: [example.reCAPTCHA_v2.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.reCAPTCHA_v2.py)
283285

284286
```python
285287
import json
@@ -298,6 +300,7 @@ captcha = client.decode(type=4, token_params=token_params)
298300
<a id="sample-type-5-recaptcha-v3-token"></a>
299301
#### 🤖 Sample Type 5: reCAPTCHA v3 Token
300302
Official description: [reCAPTCHA v3](https://deathbycaptcha.com/api/newtokenrecaptcha#reCAPTCHAv3)
303+
Full sample: [example.reCAPTCHA_v3.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.reCAPTCHA_v3.py)
301304

302305
```python
303306
import json
@@ -318,6 +321,7 @@ captcha = client.decode(type=5, token_params=token_params)
318321
<a id="sample-type-25-recaptcha-v2-enterprise"></a>
319322
#### 🏢 Sample Type 25: reCAPTCHA v2 Enterprise
320323
Official description: [reCAPTCHA v2 Enterprise](https://deathbycaptcha.com/api/newtokenrecaptcha#reCAPTCHAv2Enterprise)
324+
Full sample: [example.reCAPTCHA_v2_enterprise.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.reCAPTCHA_v2_enterprise.py)
321325

322326
```python
323327
import json
@@ -336,6 +340,7 @@ captcha = client.decode(type=25, token_enterprise_params=token_enterprise_params
336340
<a id="sample-type-8-geetest-v3"></a>
337341
#### 🧩 Sample Type 8: GeeTest v3
338342
Official description: [GeeTest](https://deathbycaptcha.com/api/geetest)
343+
Full sample: [example.Geetest_v3.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Geetest_v3.py)
339344

340345
```python
341346
import json
@@ -355,6 +360,7 @@ captcha = client.decode(type=8, geetest_params=geetest_params)
355360
<a id="sample-type-9-geetest-v4"></a>
356361
#### 🧩 Sample Type 9: GeeTest v4
357362
Official description: [GeeTest](https://deathbycaptcha.com/api/geetest)
363+
Full sample: [example.Geetest_v4.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Geetest_v4.py)
358364

359365
```python
360366
import json
@@ -373,6 +379,7 @@ captcha = client.decode(type=9, geetest_params=geetest_params)
373379
<a id="sample-type-11-text-captcha"></a>
374380
#### 💬 Sample Type 11: Text CAPTCHA
375381
Official description: [Text CAPTCHA](https://deathbycaptcha.com/api/textcaptcha)
382+
Full sample: [example.Textcaptcha.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Textcaptcha.py)
376383

377384
```python
378385
captcha = client.decode(type=11, textcaptcha="What is two plus two?")
@@ -381,6 +388,7 @@ captcha = client.decode(type=11, textcaptcha="What is two plus two?")
381388
<a id="sample-type-12-cloudflare-turnstile"></a>
382389
#### ☁️ Sample Type 12: Cloudflare Turnstile
383390
Official description: [Cloudflare Turnstile](https://deathbycaptcha.com/api/turnstile)
391+
Full sample: [example.Turnstile.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Turnstile.py)
384392

385393
```python
386394
import json
@@ -399,6 +407,7 @@ captcha = client.decode(type=12, turnstile_params=turnstile_params)
399407
<a id="sample-type-13-audio-captcha"></a>
400408
#### 🔊 Sample Type 13: Audio CAPTCHA
401409
Official description: [Audio CAPTCHA](https://deathbycaptcha.com/api/audio)
410+
Full sample: [example.Audio.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Audio.py)
402411

403412
```python
404413
import base64
@@ -411,6 +420,7 @@ captcha = client.decode(type=13, audio=audio_b64, language="en")
411420
<a id="sample-type-14-lemin"></a>
412421
#### 🔵 Sample Type 14: Lemin
413422
Official description: [Lemin](https://deathbycaptcha.com/api/lemin)
423+
Full sample: [example.Lemin.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Lemin.py)
414424

415425
```python
416426
import json
@@ -429,6 +439,7 @@ captcha = client.decode(type=14, lemin_params=lemin_params)
429439
<a id="sample-type-15-capy"></a>
430440
#### 🏴 Sample Type 15: Capy
431441
Official description: [Capy](https://deathbycaptcha.com/api/capy)
442+
Full sample: [example.Capy.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Capy.py)
432443

433444
```python
434445
import json
@@ -448,6 +459,7 @@ captcha = client.decode(type=15, capy_params=capy_params)
448459
<a id="sample-type-16-amazon-waf"></a>
449460
#### 🛡️ Sample Type 16: Amazon WAF
450461
Official description: [Amazon WAF](https://deathbycaptcha.com/api/amazonwaf)
462+
Full sample: [example.AmazonWaf.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.AmazonWaf.py)
451463

452464
```python
453465
import json
@@ -468,6 +480,7 @@ captcha = client.decode(type=16, waf_params=waf_params)
468480
<a id="sample-type-17-siara"></a>
469481
#### 🔍 Sample Type 17: Siara
470482
Official description: [Siara](https://deathbycaptcha.com/api/siara)
483+
Full sample: [example.Siara.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Siara.py)
471484

472485
```python
473486
import json
@@ -487,6 +500,7 @@ captcha = client.decode(type=17, siara_params=siara_params)
487500
<a id="sample-type-18-mtcaptcha"></a>
488501
#### 🔒 Sample Type 18: MTCaptcha
489502
Official description: [MTCaptcha](https://deathbycaptcha.com/api/mtcaptcha)
503+
Full sample: [example.Mtcaptcha.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Mtcaptcha.py)
490504

491505
```python
492506
import json
@@ -505,6 +519,7 @@ captcha = client.decode(type=18, mtcaptcha_params=mtcaptcha_params)
505519
<a id="sample-type-19-cutcaptcha"></a>
506520
#### ✂️ Sample Type 19: Cutcaptcha
507521
Official description: [Cutcaptcha](https://deathbycaptcha.com/api/cutcaptcha)
522+
Full sample: [example.Cutcaptcha.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Cutcaptcha.py)
508523

509524
```python
510525
import json
@@ -524,6 +539,7 @@ captcha = client.decode(type=19, cutcaptcha_params=cutcaptcha_params)
524539
<a id="sample-type-20-friendly-captcha"></a>
525540
#### 💚 Sample Type 20: Friendly Captcha
526541
Official description: [Friendly Captcha](https://deathbycaptcha.com/api/friendly)
542+
Full sample: [example.Friendly.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Friendly.py)
527543

528544
```python
529545
import json
@@ -542,6 +558,7 @@ captcha = client.decode(type=20, friendly_params=friendly_params)
542558
<a id="sample-type-21-datadome"></a>
543559
#### 🛡️ Sample Type 21: DataDome
544560
Official description: [DataDome](https://deathbycaptcha.com/api/datadome)
561+
Full sample: [example.Datadome.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Datadome.py)
545562

546563
```python
547564
import json
@@ -560,6 +577,7 @@ captcha = client.decode(type=21, datadome_params=datadome_params)
560577
<a id="sample-type-23-tencent"></a>
561578
#### 🇨🇳 Sample Type 23: Tencent
562579
Official description: [Tencent](https://deathbycaptcha.com/api/tencent)
580+
Full sample: [example.Tencent.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Tencent.py)
563581

564582
```python
565583
import json
@@ -578,6 +596,7 @@ captcha = client.decode(type=23, tencent_params=tencent_params)
578596
<a id="sample-type-24-atb"></a>
579597
#### 🏷️ Sample Type 24: ATB
580598
Official description: [ATB](https://deathbycaptcha.com/api/atb)
599+
Full sample: [example.Atb.py](https://github.com/deathbycaptcha/deathbycaptcha-api-client-python/blob/master/examples/example.Atb.py)
581600

582601
```python
583602
import json

0 commit comments

Comments
 (0)