Skip to content

Commit

Permalink
- Added links to API documentation to methods in README.md
Browse files Browse the repository at this point in the history 
Signed-off-by: Maxim S <[email protected]>
  • Loading branch information
@poplers24
poplers24 committed Jun 14, 2024
1 parent e3f711e commit cdf0099
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ When you submit any image-based captcha use can provide additional options to he
Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.

### Normal Captcha
To bypass a normal captcha (distorted text on an image) use the following method. This method also can be used to recognize any text on the image.
To bypass a normal captcha (distorted text on an image) use the following method. This method also can be used to recognize any text on the image. [API method description](https://2captcha.com/2captcha-api#solving_normal_captcha).
```python
result = solver.normal('path/to/captcha.jpg', param1=..., ...)
# OR
Expand All @@ -111,7 +111,7 @@ result = solver.normal('https://site-with-captcha.com/path/to/captcha.jpg', para

### Audio Captcha
To bypass an audio captcha (mp3 formats only) use the following method.
You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt".
You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt". [API method description](https://2captcha.com/2captcha-api#audio).

```python
result = solver.audio('path/to/captcha.mp3', lang = 'lang', param1=..., ...)
Expand All @@ -120,21 +120,21 @@ result = solver.audio('https://site-with-captcha.com/path/to/captcha.mp3', lang
```

### Text Captcha
This method can be used to bypass a captcha that requires answering a question provided in clear text.
This method can be used to bypass a captcha that requires answering a question provided in clear text. [API method description](https://2captcha.com/2captcha-api#solving_text_captcha).
```python
result = solver.text('If tomorrow is Saturday, what day is today?', param1=..., ...)
```

### reCAPTCHA v2
Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection. [API method description](https://2captcha.com/2captcha-api#solving_recaptchav2_new).
```python
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
url='https://mysite.com/page/with/recaptcha',
param1=..., ...)
```

### reCAPTCHA v3
This method provides a reCAPTCHA V3 solver and returns a token.
This method provides a reCAPTCHA V3 solver and returns a token. [API method description](https://2captcha.com/2captcha-api#solving_recaptchav3).
```python
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
url='https://mysite.com/page/with/recaptcha',
Expand All @@ -143,7 +143,7 @@ result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
```

### FunCaptcha
FunCaptcha (Arkoselabs) solving method. Returns a token.
FunCaptcha (Arkoselabs) solving method. Returns a token. [API method description](https://2captcha.com/2captcha-api#solving_funcaptcha_new).
```python
result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
url='https://mysite.com/page/with/funcaptcha',
Expand All @@ -153,7 +153,7 @@ result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',


### GeeTest
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON. [API method description](https://2captcha.com/2captcha-api#solving_geetest).
```python
result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
challenge='12345678abc90123d45678ef90123a456b',
Expand All @@ -164,7 +164,7 @@ result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',


### GeeTest v4
Use this method to solve GeeTest v4. Returns the response in JSON.
Use this method to solve GeeTest v4. Returns the response in JSON. [API method description](https://2captcha.com/2captcha-api#geetest-v4).
```python
result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
url='https://www.site.com/page/',
Expand All @@ -174,7 +174,7 @@ result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',


### hCaptcha
Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha.
Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha. [API method description](https://2captcha.com/2captcha-api#solving_hcaptcha).
```python
result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
url='https://www.site.com/page/',
Expand All @@ -184,7 +184,7 @@ result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',


### Lemin Cropped Captcha
Use this method to solve hCaptcha challenge. Returns JSON with an answer containing the following values: answer, challenge_id.
Use this method to solve hCaptcha challenge. Returns JSON with an answer containing the following values: answer, challenge_id. [API method description](https://2captcha.com/2captcha-api#lemin).
```python
result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
div_id='lemin-cropped-captcha',
Expand All @@ -195,7 +195,7 @@ result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d90


### Cloudflare Turnstile
Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
Use this method to solve Cloudflare Turnstile. Returns JSON with the token. [API method description](https://2captcha.com/2captcha-api#turnstile).
```python
result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
url='http://mysite.com/',
Expand All @@ -206,7 +206,7 @@ result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
```

### Amazon WAF
Use this method to solve Amazon WAF Captcha also known as AWS WAF Captcha is a part of Intelligent threat mitigation for Amazon AWS. Returns JSON with the token.
Use this method to solve Amazon WAF Captcha also known as AWS WAF Captcha is a part of Intelligent threat mitigation for Amazon AWS. Returns JSON with the token. [API method description](https://2captcha.com/2captcha-api#amazon-waf).
```python
result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
iv='CgAHbCe2GgAAAAAj',
Expand All @@ -218,7 +218,7 @@ result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',


### KeyCaptcha
Token-based method to solve KeyCaptcha.
Token-based method to solve KeyCaptcha. [API method description](https://2captcha.com/2captcha-api#solving_keycaptcha).
```python
result = solver.keycaptcha(s_s_c_user_id=10,
s_s_c_session_id='493e52c37c10c2bcdf4a00cbc9ccd1e8',
Expand All @@ -231,7 +231,7 @@ result = solver.keycaptcha(s_s_c_user_id=10,


### atbCAPTCHA
Use this method to solve atbCaptcha challenge. Returns a token to bypass the captcha.
Use this method to solve atbCaptcha challenge. Returns a token to bypass the captcha. [API method description](https://2captcha.com/2captcha-api#atb-captcha).
```python
result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
api_server='https://cap.aisecurius.com',
Expand All @@ -242,55 +242,55 @@ result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',


### Capy
Token-based method to bypass Capy puzzle captcha.
Token-based method to bypass Capy puzzle captcha. [API method description](https://2captcha.com/2captcha-api#solving_capy).
```python
result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
url='http://mysite.com/',
api_server='https://jp.api.capy.me/',
param1=..., ...)
```
### Grid
Grid method was originally called the Old reCAPTCHA V2 method. The method can be used to bypass any type of captcha where you can apply a grid on an image and click specific grid boxes. Returns numbers of boxes.
Grid method was originally called the Old reCAPTCHA V2 method. The method can be used to bypass any type of captcha where you can apply a grid on an image and click specific grid boxes. Returns numbers of boxes. [API method description](https://2captcha.com/2captcha-api#grid).
```python
result = solver.grid('path/to/captcha.jpg', param1=..., ...)
```

### Canvas
Canvas method can be used when you need to draw a line around an object on an image. Returns a set of points' coordinates to draw a polygon.
Canvas method can be used when you need to draw a line around an object on an image. Returns a set of points' coordinates to draw a polygon. [API method description](https://2captcha.com/2captcha-api#canvas).
```python
result = solver.canvas('path/to/captcha.jpg', param1=..., ...)
```

### ClickCaptcha
ClickCaptcha method returns coordinates of points on the captcha image. Can be used if you need to click on particular points in the image.
ClickCaptcha method returns coordinates of points on the captcha image. Can be used if you need to click on particular points in the image. [API method description](https://2captcha.com/2captcha-api#coordinates).
```python
result = solver.coordinates('path/to/captcha.jpg', param1=..., ...)
```

### Rotate
This method can be used to solve a captcha that asks to rotate an object. Mostly used to bypass FunCaptcha. Returns the rotation angle.
This method can be used to solve a captcha that asks to rotate an object. Mostly used to bypass FunCaptcha. Returns the rotation angle. [API method description](https://2captcha.com/2captcha-api#solving_rotatecaptcha).
```python
result = solver.rotate('path/to/captcha.jpg', param1=..., ...)
```

### MTCaptcha
Use this method to solve MTCaptcha and obtain a token to bypass the protection.
Use this method to solve MTCaptcha and obtain a token to bypass the protection. [API method description](https://2captcha.com/2captcha-api#mtcaptcha).
```python
result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
url='https://2captcha.com/demo/mtcaptcha',
param1=..., ...)
```

### Friendly Captcha
Friendly Captcha solving method. Returns a token.
Friendly Captcha solving method. Returns a token. [API method description](https://2captcha.com/2captcha-api#friendly-captcha).
```python
result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
url='https://friendlycaptcha.com/demo',
param1=..., ...)
```

### Cutcaptcha
Use this method to solve Cutcaptcha. Returns the response in JSON.
Use this method to solve Cutcaptcha. Returns the response in JSON. [API method description](https://2captcha.com/2captcha-api#cutcaptcha).
```python
result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320',
apikey='SAs61IAI',
Expand All @@ -299,7 +299,7 @@ result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320'
```

### Tencent
Use this method to solve Cutcaptcha. Returns a token.
Use this method to solve Cutcaptcha. Returns a token. [API method description](https://2captcha.com/2captcha-api#tencent).
```python
result = solver.tencent(app_id="197326679",
url="https://mysite.com/page/with/tencent",
Expand Down

0 comments on commit cdf0099

Please sign in to comment.