Skip to content

Commit ae26d2c

Browse files
authored
Readme (#76)
updated the readme
1 parent 109997e commit ae26d2c

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Python Module for 2Captcha API
2-
The easiest way to quickly integrate [2Captcha] captcha solving service into your code to automate solving of any types of captcha.
2+
The easiest way to quickly integrate the 2Captcha captcha-solving service into your code and automate the solving of any type of captcha.
33

44
- [Python Module for 2Captcha API](#python-module-for-2captcha-api)
55
- [Installation](#installation)
@@ -10,8 +10,8 @@ The easiest way to quickly integrate [2Captcha] captcha solving service into you
1010
- [Normal Captcha](#normal-captcha)
1111
- [Audio Captcha](#audio-captcha)
1212
- [Text Captcha](#text-captcha)
13-
- [ReCaptcha v2](#recaptcha-v2)
14-
- [ReCaptcha v3](#recaptcha-v3)
13+
- [reCAPTCHA v2](#recaptcha-v2)
14+
- [reCAPTCHA v3](#recaptcha-v3)
1515
- [FunCaptcha](#funcaptcha)
1616
- [GeeTest](#geetest)
1717
- [hCaptcha](#hcaptcha)
@@ -20,13 +20,14 @@ The easiest way to quickly integrate [2Captcha] captcha solving service into you
2020
- [Cloudflare Turnstile](#cloudflare-turnstile)
2121
- [Amazon WAF](#amazon-waf)
2222
- [KeyCaptcha](#keycaptcha)
23+
- [atbCAPTCHA](#atbcaptcha)
2324
- [Capy](#capy)
2425
- [Grid](#grid)
2526
- [Canvas](#canvas)
2627
- [ClickCaptcha](#clickcaptcha)
2728
- [Rotate](#rotate)
2829
- [MTCaptcha](#mtcaptcha)
29-
- [Friendly Captcha](#friendly_captcha)
30+
- [Friendly Captcha](#friendly-captcha)
3031
- [Cutcaptcha](#cutcaptcha)
3132
- [Other methods](#other-methods)
3233
- [send / getResult](#send--getresult)
@@ -52,7 +53,7 @@ from twocaptcha import TwoCaptcha
5253

5354
solver = TwoCaptcha('YOUR_API_KEY')
5455
```
55-
Also there are few options that can be configured:
56+
Also there are a few options that can be configured:
5657

5758
```python
5859
config = {
@@ -74,8 +75,8 @@ solver = TwoCaptcha(**config)
7475
| server | `2captcha.com` | API server. You can set it to `rucaptcha.com` if your account is registered there |
7576
| softId | - | your software ID obtained after publishing in [2captcha sofware catalog] |
7677
| callback | - | URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account |
77-
| defaultTimeout | 120 | Polling timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from `res.php` API endpoint |
78-
| recaptchaTimeout | 600 | Polling timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint |
78+
| defaultTimeout | 120 | Polling timeout in seconds for all captcha types except reCAPTCHA. Defines how long the module tries to get the answer from `res.php` API endpoint |
79+
| recaptchaTimeout | 600 | Polling timeout for reCAPTCHA in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint |
7980
| pollingInterval | 10 | Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended |
8081

8182
> **IMPORTANT:** once `callback` is defined for `TwoCaptcha` instance, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL.
@@ -100,7 +101,7 @@ When you submit any image-based captcha use can provide additional options to he
100101
Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.
101102

102103
### Normal Captcha
103-
To bypass a normal captcha (distorted text on image) use the following method. This method also can be used to recognize any text on the image.
104+
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.
104105
```python
105106
result = solver.normal('path/to/captcha.jpg', param1=..., ...)
106107
# OR
@@ -109,7 +110,7 @@ result = solver.normal('https://site-with-captcha.com/path/to/captcha.jpg', para
109110

110111
### Audio Captcha
111112
To bypass an audio captcha (mp3 formats only) use the following method.
112-
You must provife the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt".
113+
You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt".
113114

114115
```python
115116
result = solver.audio('path/to/captcha.mp3', lang = 'lang', param1=..., ...)
@@ -118,21 +119,21 @@ result = solver.audio('https://site-with-captcha.com/path/to/captcha.mp3', lang
118119
```
119120

120121
### Text Captcha
121-
This method can be used to bypass a captcha that requires to answer a question provided in clear text.
122+
This method can be used to bypass a captcha that requires answering a question provided in clear text.
122123
```python
123124
result = solver.text('If tomorrow is Saturday, what day is today?', param1=..., ...)
124125
```
125126

126-
### ReCaptcha v2
127-
Use this method to solve ReCaptcha V2 and obtain a token to bypass the protection.
127+
### reCAPTCHA v2
128+
Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
128129
```python
129130
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
130131
url='https://mysite.com/page/with/recaptcha',
131132
param1=..., ...)
132133
```
133134

134-
### ReCaptcha v3
135-
This method provides ReCaptcha V3 solver and returns a token.
135+
### reCAPTCHA v3
136+
This method provides a reCAPTCHA V3 solver and returns a token.
136137
```python
137138
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
138139
url='https://mysite.com/page/with/recaptcha',
@@ -162,7 +163,7 @@ result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
162163

163164

164165
### hCaptcha
165-
Use this method to solve hCaptcha challenge. Returns a token to bypass captcha.
166+
Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha.
166167
```python
167168
result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
168169
url='https://www.site.com/page/',
@@ -181,7 +182,7 @@ result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
181182

182183

183184
### Lemin Cropped Captcha
184-
Use this method to solve hCaptcha challenge. Returns JSON with answer containing the following values: answer, challenge_id.
185+
Use this method to solve hCaptcha challenge. Returns JSON with an answer containing the following values: answer, challenge_id.
185186
```python
186187
result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
187188
div_id='lemin-cropped-captcha',
@@ -228,7 +229,7 @@ result = solver.keycaptcha(s_s_c_user_id=10,
228229

229230

230231
### atbCAPTCHA
231-
Use this method to solve atbCaptcha challenge. Returns a token to bypass captcha.
232+
Use this method to solve atbCaptcha challenge. Returns a token to bypass the captcha.
232233
```python
233234
result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
234235
api_server='https://cap.aisecurius.com',
@@ -247,17 +248,19 @@ result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
247248
param1=..., ...)
248249
```
249250
### Grid
250-
Grid method is originally called Old ReCaptcha V2 method. The method can be used to bypass any type of captcha where you can apply a grid on image and need to click specific grid boxes. Returns numbers of boxes.
251+
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.
251252
```python
252253
result = solver.grid('path/to/captcha.jpg', param1=..., ...)
253254
```
255+
254256
### Canvas
255-
Canvas method can be used when you need to draw a line around an object on image. Returns a set of points' coordinates to draw a polygon.
257+
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.
256258
```python
257259
result = solver.canvas('path/to/captcha.jpg', param1=..., ...)
258260
```
261+
259262
### ClickCaptcha
260-
ClickCaptcha method returns coordinates of points on captcha image. Can be used if you need to click on particular points on the image.
263+
ClickCaptcha method returns coordinates of points on the captcha image. Can be used if you need to click on particular points in the image.
261264
```python
262265
result = solver.coordinates('path/to/captcha.jpg', param1=..., ...)
263266
```
@@ -316,7 +319,7 @@ balance = solver.balance()
316319
```
317320

318321
### report
319-
Use this method to report good or bad captcha answer.
322+
Use this method to report good or bad captcha answers.
320323
```python
321324
solver.report(id, True) # captcha solved correctly
322325
solver.report(id, False) # captcha solved incorrectly

0 commit comments

Comments
 (0)