Skip to content

Commit 95283ca

Browse files
Merge pull request #102 from 2captcha/RC-2795-fix-readme
RC-2795-fix-readme
2 parents 897334f + c65b51f commit 95283ca

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ The easiest way to quickly integrate the [2Captcha] captcha-solving service into
3434
- [send / get_result](#send--get_result)
3535
- [balance](#balance)
3636
- [report](#report)
37-
- [Error handling](#error-handling)
38-
- [Proxies](#proxies)
39-
- [Async calls](#async-calls)
37+
- [Error handling](#error-handling)
38+
- [Proxies](#proxies)
39+
- [Async calls](#async-calls)
4040
- [Examples](#examples)
41+
- [Useful articles](#useful-articles)
4142

4243
## Installation
4344

@@ -83,7 +84,9 @@ solver = TwoCaptcha(**config)
8384
| recaptchaTimeout | 600 | Polling timeout for reCAPTCHA in seconds. Defines how long the module tries to get the answer from the `res.php` API endpoint |
8485
| pollingInterval | 10 | Interval in seconds between requests to the `res.php` API endpoint. Setting values less than 5 seconds is not recommended |
8586

86-
> **IMPORTANT:** Once `callback` is defined for the `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.
87+
> [!IMPORTANT]
88+
> Once `callback` is defined for the `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.
89+
8790
To get the answer manually use [get_result method](#send--get_result)
8891

8992
## Solve captcha
@@ -355,6 +358,10 @@ result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
355358
<sup>[API method description.](https://2captcha.com/2captcha-api#friendly-captcha)</sup>
356359

357360
Friendly Captcha solving method. Returns a token.
361+
362+
> [!IMPORTANT]
363+
> To successfully use the received token, the captcha widget must not be loaded on the page. To do this, you need to abort request to `/friendlycaptcha/...module.min.js` on the page. When the captcha widget is already loaded on the page, there is a high probability that the received token will not work.
364+
358365
```python
359366
result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
360367
url='https://friendlycaptcha.com/demo',
@@ -415,20 +422,27 @@ code = solver.get_result(id)
415422
```
416423

417424
### balance
425+
426+
<sup>[API method description.](https://2captcha.com/2captcha-api#additional-methods)</sup>
427+
418428
Use this method to get your account's balance
419429
```python
420430
balance = solver.balance()
421431
```
422432

423433
### report
434+
435+
<sup>[API method description.](https://2captcha.com/2captcha-api#complain)</sup>
436+
424437
Use this method to report good or bad captcha answers.
425438
```python
426439
solver.report(id, True) # captcha solved correctly
427440
solver.report(id, False) # captcha solved incorrectly
428441
```
429442

430-
### Error handling
431-
In case of an error, the captcha solver throws an exception. It's important to properly handle these cases. We recommend using `try except` to handle exceptions.
443+
## Error handling
444+
In case of an error, the captcha solver throws an exception. It's important to properly handle these cases. We recommend using `try except` to handle exceptions.
445+
The list of all errors can be found in the [API documentation](https://2captcha.com/2captcha-api#list-of-inphp-errors).
432446
```python
433447
try:
434448
result = solver.text('If tomorrow is Saturday, what day is today?')
@@ -447,7 +461,7 @@ except TimeoutException as e:
447461
```
448462

449463

450-
### Proxies
464+
## Proxies
451465

452466
You can pass your proxy as an additional argument for the following methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha,
453467
keycaptcha, capy puzzle, lemin, atbcaptcha, turnstile, amazon waf, mtcaptcha, friendly captcha, cutcaptcha.
@@ -463,7 +477,7 @@ proxy={
463477
}
464478
```
465479

466-
### Async calls
480+
## Async calls
467481
You can also make async calls with [asyncio], for example:
468482

469483
```python
@@ -485,6 +499,11 @@ captcha_result = asyncio.run(captchaSolver(image))
485499
## Examples
486500
Examples of solving all supported captcha types are located in the [examples] directory.
487501

502+
## Useful articles
503+
504+
- Amazon captcha solver: Code example for bypassing the [Amazon captcha](https://2captcha.com/blog/amazon-captcha-solving)
505+
- [Captcha bypass in Selenium](https://2captcha.com/blog/captcha-bypass-in-selenium)
506+
488507
<!-- Shared links for README.md -->
489508
[2Captcha]: https://2captcha.com/
490509
[2captcha software catalog]: https://2captcha.com/software

0 commit comments

Comments
 (0)