Add Hunt captcha support with tests and examples (#142)

Author: poplers24

README.md

@@ -51,6 +51,7 @@ Examples of API requests for different captcha types are available on the [Pytho
     - [Altcha Captcha](#altcha-Captcha)
     - [Binance](#binance)
     - [Yidun](#yidun)
+    - [Hunt](#hunt)
   - [Other methods](#other-methods)
     - [send / get\_result](#send--get_result)
     - [balance](#balance)
@@ -560,6 +561,17 @@ result = solver.yidun(sitekey='6b4d7e0c4f5a4c7db2f3a1e8c9d6f123',
     )
 ```
 
+### Hunt
+
+<sup>[API method description.](https://2captcha.com/2captcha-api#hunt)</sup>
+
+Use this method to solve Hunt captcha. Returns a token.
+```python
+result = solver.hunt(pageurl='https://example.com/page-with-hunt',
+                     api_get_lib='https://example.com/hd-api/external/apps/app-id/api.js',
+                     )
+```
+
 ## Other methods
 
 ### send / get_result

examples/async/async_hunt.py

@@ -0,0 +1,31 @@
+import asyncio
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import AsyncTwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = AsyncTwoCaptcha(api_key)
+
+async def solve_captcha():
+    try:
+        return await solver.hunt(
+            pageurl='https://example.com/page-with-hunt',
+            api_get_lib='https://example.com/hd-api/external/apps/app-id/api.js',
+        )
+
+    except Exception as e:
+        sys.exit(e)
+
+if __name__ == '__main__':
+    result = asyncio.run(solve_captcha())
+    sys.exit('result: ' + str(result))

examples/async/async_hunt_options.py

@@ -0,0 +1,43 @@
+import asyncio
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import AsyncTwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+config = {
+            'server':           '2captcha.com', # can be also set to 'rucaptcha.com'
+    		'apiKey':           api_key,
+    		'softId':            123,
+    		'defaultTimeout':    120,
+    		'recaptchaTimeout':  600,
+    		'pollingInterval':   10,
+	    }
+
+solver = AsyncTwoCaptcha(**config)
+
+async def solve_captcha():
+    try:
+        return await solver.hunt(
+            pageurl='https://example.com/page-with-hunt',
+            api_get_lib='https://example.com/hd-api/external/apps/app-id/api.js',
+            data='META_TOKEN_VALUE',
+            useragent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+            # proxy={'type': 'HTTP',
+            #        'uri': 'login:password@IP_address:PORT'}
+        )
+    except Exception as e:
+        sys.exit(e)
+
+if __name__ == '__main__':
+    result = asyncio.run(solve_captcha())
+    sys.exit('result: ' + str(result))

examples/sync/hunt.py

@@ -0,0 +1,28 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.hunt(
+        pageurl='https://example.com/page-with-hunt',
+        api_get_lib='https://example.com/hd-api/external/apps/app-id/api.js',
+    )
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))

examples/sync/hunt_options.py

@@ -0,0 +1,41 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+config = {
+            'server':           '2captcha.com', # can be also set to 'rucaptcha.com'
+    		'apiKey':           api_key,
+    		'softId':            123,
+    		'defaultTimeout':    120,
+    		'recaptchaTimeout':  600,
+    		'pollingInterval':   10,
+	    }
+
+solver = TwoCaptcha(**config)
+
+try:
+    result = solver.hunt(
+        pageurl='https://example.com/page-with-hunt',
+        api_get_lib='https://example.com/hd-api/external/apps/app-id/api.js',
+        data='META_TOKEN_VALUE',
+        useragent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+        # proxy={'type': 'HTTP',
+        #        'uri': 'login:password@IP_address:PORT'}
+    )
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))

setup.py

@@ -36,6 +36,6 @@ def get_version():
           '2captcha', 'captcha', 'api', 'captcha solver', 'reCAPTCHA',
           'FunCaptcha', 'Geetest', 'image captcha', 'Coordinates', 'Click Captcha',
           'Geetest V4', 'Lemin captcha', 'Amazon WAF', 'Cloudflare Turnstile',
-          'Capy Puzzle', 'MTCaptcha', 'Friendly Captcha', 'Tencent', 'Cutcaptcha', 'DataDome', 'VK Captcha', 'CaptchaFox', 'Prosopo', 'cybersiara'],
+          'Capy Puzzle', 'MTCaptcha', 'Friendly Captcha', 'Tencent', 'Cutcaptcha', 'DataDome', 'VK Captcha', 'CaptchaFox', 'Prosopo', 'cybersiara', 'Hunt'],
       python_requires='>=3.8',
       test_suite='tests')

tests/async/test_async_hunt.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+
+import unittest
+
+try:
+    from .abstract_async import AsyncAbstractTest
+except ImportError:
+    from abstract_async import AsyncAbstractTest
+
+
+class AsyncHunt(AsyncAbstractTest):
+    def test_all_params(self):
+        params = {
+                'pageurl': 'https://example.com/page-with-hunt',
+                'api_get_lib': 'https://example.com/hd-api/external/apps/app-id/api.js',
+                'data': 'META_TOKEN_VALUE',
+                'useragent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+                'proxy': {'type': 'HTTP',
+                          'uri': 'login:password@IP_address:PORT'}
+        }
+
+        sends = {
+                'method': 'hunt',
+                'pageurl': 'https://example.com/page-with-hunt',
+                'api_get_lib': 'https://example.com/hd-api/external/apps/app-id/api.js',
+                'data': 'META_TOKEN_VALUE',
+                'useragent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+                'proxytype': 'HTTP',
+                'proxy': 'login:password@IP_address:PORT'
+        }
+
+        self.send_return(sends, self.solver.hunt, **params)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/sync/test_hunt.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+
+import unittest
+
+try:
+    from .abstract import AbstractTest
+except ImportError:
+    from abstract import AbstractTest
+
+
+class CaptchaHunt(AbstractTest):
+
+    def test_all_params(self):
+        params = {
+            'pageurl': 'https://example.com/page-with-hunt',
+            'api_get_lib': 'https://example.com/hd-api/external/apps/app-id/api.js',
+            'data': 'META_TOKEN_VALUE',
+            'useragent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+            'proxy': {'type': 'HTTP',
+                      'uri': 'login:password@IP_address:PORT'}
+        }
+
+        sends = {
+            'method': 'hunt',
+            'pageurl': 'https://example.com/page-with-hunt',
+            'api_get_lib': 'https://example.com/hd-api/external/apps/app-id/api.js',
+            'data': 'META_TOKEN_VALUE',
+            'useragent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36',
+            'proxytype': 'HTTP',
+            'proxy': 'login:password@IP_address:PORT'
+        }
+
+        return self.send_return(sends, self.solver.hunt, **params)
+
+
+if __name__ == '__main__':
+    unittest.main()

twocaptcha/async_solver.py

@@ -1077,6 +1077,31 @@ async def yidun(self, sitekey, pageurl, **kwargs):
 
         return await result
 
+    async def hunt(self, pageurl, api_get_lib, **kwargs):
+        '''Wrapper for solving Hunt captcha.
+
+        Parameters
+        __________
+        pageurl : str
+            Full URL of the page with the captcha.
+        api_get_lib : str
+            Full link to the api.js file that loads the captcha on the page.
+        data : str, optional
+            Value of `meta.token` that the site returned after a request with X-HD.
+            Use only for the captcha solving mode (second step).
+        useragent : str, optional
+            Browser User-Agent used to open the page.
+        proxy : dict, optional
+            {'type': 'HTTPS', 'uri': 'login:password@IP_address:PORT'}.
+        '''
+        result = self.solve(
+            method="hunt",
+            pageurl=pageurl,
+            api_get_lib=api_get_lib,
+            **kwargs)
+
+        return await result
+
     async def solve(self, timeout=0, polling_interval=0, **kwargs):
         '''Sends captcha, receives result.
 

twocaptcha/solver.py

@@ -113,6 +113,8 @@ class TwoCaptcha():
         Wrapper for solving Binance captcha.
     yidun(self, sitekey, pageurl, **kwargs)
         Wrapper for solving Yidun captcha.
+    hunt(self, pageurl, api_get_lib, **kwargs)
+        Wrapper for solving Hunt captcha.
     solve(timeout=0, polling_interval=0, **kwargs)
         Sends CAPTCHA data and retrieves the result.
     balance()
@@ -1219,6 +1221,31 @@ def yidun(self, sitekey, pageurl, **kwargs):
 
         return result
 
+    def hunt(self, pageurl, api_get_lib, **kwargs):
+        '''Wrapper for solving Hunt captcha.
+
+        Parameters
+        __________
+        pageurl : str
+            Full URL of the page with the captcha.
+        api_get_lib : str
+            Full link to the api.js file that loads the captcha on the page.
+        data : str, optional
+            Value of `meta.token` that the site returned after a request with X-HD.
+            Use only for the captcha solving mode (second step).
+        useragent : str, optional
+            Browser User-Agent used to open the page.
+        proxy : dict, optional
+            {'type': 'HTTPS', 'uri': 'login:password@IP_address:PORT'}.
+        '''
+        result = self.solve(
+            method="hunt",
+            pageurl=pageurl,
+            api_get_lib=api_get_lib,
+            **kwargs)
+
+        return result
+
 
     def solve(self, timeout=0, polling_interval=0, **kwargs):
         '''Sends captcha, receives result.