2captcha-python 1.2.6__tar.gz → 1.2.8__tar.gz

{2captcha_python-1.2.6 → 2captcha_python-1.2.8/2captcha_python.egg-info}/PKG-INFO

@@ -1,20 +1,25 @@
 Metadata-Version: 2.1
 Name: 2captcha-python
-Version: 1.2.6
+Version: 1.2.8
 Summary: Python module for easy integration with 2Captcha API
 Home-page: https://github.com/2captcha/2captcha-python/
 Author: 2Captcha
 Author-email: info@2captcha.com
+Keywords: 2captcha,captcha,api,captcha solver,reCAPTCHA,hCaptcha,FunCaptcha,Geetest,image captcha,Coordinates,Click Captcha,Geetest V4,Lemin captcha,Amazon WAF,Cloudflare Turnstile,Capy Puzzle,MTCaptcha,Friendly Captcha,Tencent
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Utilities
+Classifier: Intended Audience :: Developers
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
 
 # Python Module for 2Captcha API
-The easiest way to quickly integrate the 2Captcha captcha-solving service into your code and automate the solving of any type of captcha.
+The easiest way to quickly integrate the [2Captcha] captcha-solving service into your code and automate the solving of any type of captcha.
 
 - [Python Module for 2Captcha API](#python-module-for-2captcha-api)
   - [Installation](#installation)
@@ -29,8 +34,8 @@ The easiest way to quickly integrate the 2Captcha captcha-solving service into y
     - [reCAPTCHA v3](#recaptcha-v3)
     - [FunCaptcha](#funcaptcha)
     - [GeeTest](#geetest)
-    - [hCaptcha](#hcaptcha)
     - [GeeTest v4](#geetest-v4)
+    - [hCaptcha](#hcaptcha)
     - [Lemin Cropped Captcha](#lemin-cropped-captcha)
     - [Cloudflare Turnstile](#cloudflare-turnstile)
     - [Amazon WAF](#amazon-waf)
@@ -49,15 +54,19 @@ The easiest way to quickly integrate the 2Captcha captcha-solving service into y
     - [send / get_result](#send--get_result)
     - [balance](#balance)
     - [report](#report)
-    - [Error handling](#error-handling)
-    - [Proxies](#proxies)
-    - [Async calls](#async-calls)
+  - [Error handling](#error-handling)
+  - [Proxies](#proxies)
+  - [Async calls](#async-calls)
+  - [Examples](#examples)
+  - [Useful articles](#useful-articles)
 
 ## Installation
 
 This package can be installed with Pip:
 
-```pip3 install 2captcha-python```
+```bash
+pip3 install 2captcha-python
+```
 
 
 ## Configuration
@@ -69,7 +78,7 @@ from twocaptcha import TwoCaptcha
 
 solver = TwoCaptcha('YOUR_API_KEY')
 ```
-Also there are a few options that can be configured:
+Also, there are a few options that can be configured:
 
 ```python 
 config = {
@@ -86,38 +95,44 @@ solver = TwoCaptcha(**config)
 
 ### TwoCaptcha instance options
 
-| Option           | Default value  | Description                                                                                                                                        |
-| ---------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| server           | `2captcha.com` | API server. You can set it to `rucaptcha.com` if your account is registered there                                                                  |
-| softId           | -              | your software ID obtained after publishing in [2captcha sofware catalog]                                                                           |
-| callback         | -              | URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account      |
-| 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 |
-| recaptchaTimeout | 600            | Polling timeout for reCAPTCHA in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint                          |
-| pollingInterval  | 10             | Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended                              |
+| Option           | Default value  | Description                                                                                                                                            |
+| ---------------- | -------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------|
+| server           | `2captcha.com` | API server. You can set it to `rucaptcha.com` if your account is registered there                                                                      |
+| softId           | 4580           | your software ID obtained after publishing in [2captcha software catalog]                                                                              |
+| callback         | -              | URL of your web server that receives the captcha recognition result. The URL should be first registered in [pingback settings] of your account         |
+| defaultTimeout   | 120            | Polling timeout in seconds for all captcha types except reCAPTCHA. Defines how long the module tries to get the answer from the `res.php` API endpoint |
+| recaptchaTimeout | 600            | Polling timeout for reCAPTCHA in seconds. Defines how long the module tries to get the answer from the `res.php` API endpoint                          |
+| pollingInterval  | 10             | Interval in seconds between requests to the `res.php` API endpoint. Setting values less than 5 seconds is not recommended                              |
+
+> [!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.
 
->  **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.
 To get the answer manually use [get_result method](#send--get_result)
 
 ## Solve captcha
-When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.
+When you submit any image-based CAPTCHA, you can provide additional options to help 2captcha workers solve it properly.
 
 ### Captcha options
 | Option        | Default Value | Description                                                                                        |
 | ------------- | ------------- | -------------------------------------------------------------------------------------------------- |
-| numeric       | 0             | Defines if captcha contains numeric or other symbols [see more info in the API docs][post options] |
-| minLen        | 0             | minimal answer lenght                                                                              |
+| numeric       | 0             | Defines if the captcha contains numeric or other symbols [see more info in the API docs][post options] |
+| minLen        | 0             | minimal answer length                                                                              |
 | maxLen        | 0             | maximum answer length                                                                              |
 | phrase        | 0             | defines if the answer contains multiple words or not                                               |
 | caseSensitive | 0             | defines if the answer is case sensitive                                                            |
 | calc          | 0             | defines captcha requires calculation                                                               |
-| lang          | -             | defines the captcha language, see the [list of supported languages]                                |
-| hintImg       | -             | an image with hint shown to workers with the captcha                                               |
+| lang          | -             | defines the captcha language; see the [list of supported languages]                                |
+| hintImg       | -             | an image with a hint shown to workers with the captcha                                               |
 | hintText      | -             | hint or task text shown to workers with the captcha                                                |
 
-Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.
+Below, you can find basic examples for every captcha type. Check out [examples directory] for 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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_normal_captcha)</sup>
+
+To bypass a normal captcha (distorted text on an image) use the following method. This method can also be used to recognize any text in an image.
+
 ```python 
 result = solver.normal('path/to/captcha.jpg', param1=..., ...)
 # OR
@@ -125,7 +140,10 @@ 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. 
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#audio)</sup>
+
+Use the following method to bypass an audio captcha (mp3 formats only). 
 You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt", "fr".
 
 ```python 
@@ -135,13 +153,20 @@ result = solver.audio('https://site-with-captcha.com/path/to/captcha.mp3', lang
 ```
 
 ### Text Captcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_text_captcha)</sup>
+
 This method can be used to bypass a captcha that requires answering a question provided in clear text.
 ```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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav2_new)</sup>
+
+Use the following method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
+
 ```python 
 result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
                           url='https://mysite.com/page/with/recaptcha',
@@ -149,6 +174,9 @@ result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
 ```
 
 ### reCAPTCHA v3
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav3)</sup>
+
 This method provides a reCAPTCHA V3 solver and returns a token.
 ```python
 result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -158,6 +186,9 @@ result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
 ```
 
 ### FunCaptcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_funcaptcha_new)</sup>
+
 FunCaptcha (Arkoselabs) solving method. Returns a token.
 ```python
 result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -168,6 +199,9 @@ result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
 
 
 ### GeeTest
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_geetest)</sup>
+
 Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
 ```python
 result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
@@ -179,6 +213,9 @@ result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
 
 
 ### GeeTest v4
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#geetest-v4)</sup>
+
 Use this method to solve GeeTest v4. Returns the response in JSON.
 ```python
 result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
@@ -189,6 +226,9 @@ result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
 
 
 ### hCaptcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_hcaptcha)</sup>
+
 Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha.
 ```python
 result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
@@ -199,7 +239,10 @@ 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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#lemin)</sup>
+
+Use this method to solve the Lemin captcha. Returns JSON with an answer containing the following values: answer, challenge_id.
 ```python
 result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
                             div_id='lemin-cropped-captcha', 
@@ -210,6 +253,9 @@ result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d90
 
 
 ### Cloudflare Turnstile
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#turnstile)</sup>
+
 Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
 ```python
 result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
@@ -221,6 +267,9 @@ result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
 ```
 
 ### Amazon WAF
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#amazon-waf)</sup>
+
 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.
 ```python
 result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
@@ -233,6 +282,9 @@ result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
 
 
 ### KeyCaptcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_keycaptcha)</sup>
+
 Token-based method to solve KeyCaptcha.
 ```python
 result = solver.keycaptcha(s_s_c_user_id=10,
@@ -246,6 +298,9 @@ result = solver.keycaptcha(s_s_c_user_id=10,
 
 
 ### atbCAPTCHA
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#atb-captcha)</sup>
+
 Use this method to solve atbCaptcha challenge. Returns a token to bypass the captcha.
 ```python
 result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
@@ -257,6 +312,9 @@ result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
 
 
 ### Capy
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_capy)</sup>
+
 Token-based method to bypass Capy puzzle captcha.
 ```python
 result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
@@ -265,30 +323,49 @@ result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
                      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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#grid)</sup>
+
+The 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.
+
 ```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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#canvas)</sup>
+
+The 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.
+
 ```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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#coordinates)</sup>
+
+The ClickCaptcha method returns the coordinates of points on the captcha image. It can be used if you need to click on particular points in the image.
+
 ```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.
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#solving_rotatecaptcha)</sup>
+
+This method can be used to solve a captcha that asks to rotate an object. It is mostly used to bypass FunCaptcha. Returns the rotation angle.
+
 ```python
 result = solver.rotate('path/to/captcha.jpg', param1=..., ...)
 ```
 
 ### MTCaptcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#mtcaptcha)</sup>
+
 Use this method to solve MTCaptcha and obtain a token to bypass the protection.
 ```python
 result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
@@ -297,7 +374,14 @@ result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
 ```
 
 ### Friendly Captcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#friendly-captcha)</sup>
+
 Friendly Captcha solving method. Returns a token.
+
+> [!IMPORTANT]
+> 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.
+
 ```python
 result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
                                  url='https://friendlycaptcha.com/demo',
@@ -305,6 +389,9 @@ result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
 ```
 
 ### Cutcaptcha
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#cutcaptcha)</sup>
+
 Use this method to solve Cutcaptcha. Returns the response in JSON.
 ```python
 result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320',
@@ -314,6 +401,9 @@ result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320'
 ```
 
 ### Tencent
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#tencent)</sup>
+
 Use this method to solve Cutcaptcha. Returns a token.
 ```python
 result = solver.tencent(app_id="197326679",
@@ -324,7 +414,11 @@ result = solver.tencent(app_id="197326679",
 ## Other methods
 
 ### send / get_result
-These methods can be used for manual captcha submission and answer polling.
+These methods can be used for manual captcha submission and answer polling. The `send()` method supports sending any captcha 
+type, to specify the captcha type you must send value `method` manually, for example `method='hcaptcha'` for solving hCapthca. 
+You can find the value of the `method` parameter in the [API documentation](https://2captcha.com/2captcha-api).
+
+Example for solving Normal captcha manually:
 ```python
 import time
 . . . . . 
@@ -333,24 +427,42 @@ import time
 id = solver.send(file='path/to/captcha.jpg')
 time.sleep(20)
 
+code = solver.get_result(id)
+```
+Example for solving hCaptcha manually:
+```python
+import time
+. . . . . 
+id = solver.send(sitekey='41b778e7-8f20-45cc-a804-1f1ebb45c579',
+                 url='https://2captcha.com/demo/hcaptcha?difficulty=easy',
+                 method='hcaptcha')
+print(id)
+time.sleep(20)
 code = solver.get_result(id)
 ```
 
 ### balance
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#additional-methods)</sup>
+
 Use this method to get your account's balance
 ```python
 balance = solver.balance()
 ```
 
 ### report
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#complain)</sup>
+
 Use this method to report good or bad captcha answers.
 ```python
 solver.report(id, True) # captcha solved correctly
 solver.report(id, False) # captcha solved incorrectly
 ```
 
-### Error handling
-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. 
+## Error handling
+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.
+The list of all errors can be found in the  [API documentation](https://2captcha.com/2captcha-api#list-of-inphp-errors).
 ```python
 try:
     result = solver.text('If tomorrow is Saturday, what day is today?')
@@ -369,13 +481,14 @@ except TimeoutException as e:
 ```
 
 
-### Proxies
+## Proxies
+
+You can pass your proxy as an additional argument for the following methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, 
+keycaptcha, capy puzzle, lemin, atbcaptcha, turnstile, amazon waf, mtcaptcha, friendly captcha, cutcaptcha. 
 
-You can pass your proxy as an additional argument for methods: recaptcha, funcaptcha, geetest, geetest v4, hcaptcha, 
-keycaptcha, capy puzzle, lemin, atbcaptcha, turnstile, tencent, amazon waf, mtcaptcha, friendly captcha, cutcaptcha. 
 The proxy will be forwarded to the API to solve the captcha.
 
-We have our own proxies that we can offer you. [Buy residential proxies] for avoid restrictions and blocks. [Quick start].
+We have our own proxies that we can offer you. [Buy residential proxies] to avoid restrictions and blocks. [Quick start].
 
 ```python
 proxy={
@@ -384,7 +497,7 @@ proxy={
 }
 ```
 
-### Async calls
+## Async calls
 You can also make async calls with [asyncio], for example:
 
 ```python
@@ -403,10 +516,17 @@ async def captchaSolver(image):
 
 captcha_result = asyncio.run(captchaSolver(image))
 ```
+## Examples
+Examples of solving all supported captcha types are located in the [examples] directory.
+
+## Useful articles
 
+- Amazon captcha solver: Code example for bypassing the [Amazon captcha](https://2captcha.com/blog/amazon-captcha-solving)
+- [Captcha bypass in Selenium](https://2captcha.com/blog/captcha-bypass-in-selenium)
 
+<!-- Shared links for README.md -->
 [2Captcha]: https://2captcha.com/
-[2captcha sofware catalog]: https://2captcha.com/software
+[2captcha software catalog]: https://2captcha.com/software
 [pingback settings]: https://2captcha.com/setting/pingback
 [post options]: https://2captcha.com/2captcha-api#normal_post
 [list of supported languages]: https://2captcha.com/2captcha-api#language
@@ -414,3 +534,4 @@ captcha_result = asyncio.run(captchaSolver(image))
 [asyncio]: https://docs.python.org/3/library/asyncio.html
 [Buy residential proxies]: https://2captcha.com/proxy/residential-proxies
 [Quick start]: https://2captcha.com/proxy?openAddTrafficModal=true
+[examples]: ./examples