ImageToTextCaptcha¶

To import this module:

from python3_anticaptcha.image_captcha import ImageToTextCaptcha

class python3_anticaptcha.image_captcha.ImageToTextCaptcha(api_key: str, captcha_type: CaptchaTypeEnm | str = CaptchaTypeEnm.ImageToTextTask, sleep_time: int = 5, save_format: str | SaveFormatsEnm = SaveFormatsEnm.TEMP, img_clearing: bool = True, img_path: str = 'PythonAntiCaptchaImages')¶

__init__(api_key: str, captcha_type: CaptchaTypeEnm | str = CaptchaTypeEnm.ImageToTextTask, sleep_time: int = 5, save_format: str | SaveFormatsEnm = SaveFormatsEnm.TEMP, img_clearing: bool = True, img_path: str = 'PythonAntiCaptchaImages')¶

The class is used to work with ImageToTextTask.

Parameters:

api_key (str) – Capsolver API key
captcha_type (CaptchaTypeEnm | str) – Captcha type
sleep_time (int) – The waiting time between requests to get the result of the Captcha
save_format (str | SaveFormatsEnm) – Image save format - temporary or persistance
img_clearing (bool) – True - delete file after solution, False - don’t delete file after solution
img_path (str) – Folder to save captcha images

Examples

>>> ImageToTextCaptcha(api_key="99d7d111a0111dc11184111c8bb111da",
...                     save_format=SaveFormatsEnm.CONST
...        ).captcha_handler(captcha_file='files/captcha-image.jpg')
{
   "errorId": 0,
   "errorCode": None,
   "errorDescription": None,
   "status":"ready",
   "solution":{
      "text":"qGphJD",
      "url":"http://69.65.31.125/986/172815194092195.jpg"
   },
   "cost": 0.002,
   "ip": "46.53.249.230",
   "createTime": 1679004358,
   "endTime": 1679004368,
   "solveCount": 0,
   "taskId": 396687629
}

>>> ImageToTextCaptcha(api_key="99d7d111a0111dc11184111c8bb111da",
...                     save_format=SaveFormatsEnm.CONST
...        ).captcha_handler(captcha_link='https://........../captcha-image.jpg')
{
   "errorId": 0,
   "errorCode": None,
   "errorDescription": None,
   "status":"ready",
   "solution":{
      "text":"qGphJD",
      "url":"http://69.65.31.125/986/172815194092195.jpg"
   },
   "cost": 0.002,
   "ip": "46.53.249.230",
   "createTime": 1679004358,
   "endTime": 1679004368,
   "solveCount": 0,
   "taskId": 396687629
}

>>> await ImageToTextCaptcha(api_key="99d7d111a0111dc11184111c8bb111da",
...                     save_format=SaveFormatsEnm.CONST
...        ).aio_captcha_handler(captcha_link='https://........../captcha-image.jpg')
{
   "errorId": 0,
   "errorCode": None,
   "errorDescription": None,
   "status":"ready",
   "solution":{
      "text":"qGphJD",
      "url":"http://69.65.31.125/986/172815194092195.jpg"
   },
   "cost": 0.002,
   "ip": "46.53.249.230",
   "createTime": 1679004358,
   "endTime": 1679004368,
   "solveCount": 0,
   "taskId": 396687629
}

Notes

https://anti-captcha.com/apidoc/task-types/ImageToTextTask

captcha_handler(captcha_link: str | None = None, captcha_file: str | None = None, captcha_base64: bytes | None = None, **additional_params) → dict¶

Synchronous method for captcha solving

Parameters:

captcha_link (str | None) – link to captcha image file
captcha_file (str | None) – path to local captcha image file
captcha_base64 (bytes | None) – captcha image encoded in base64 format
additional_params – Some additional parameters that will be used in creating the task and will be passed to the payload under task key. Like proxyLogin, proxyPassword and etc. - more info in service docs

Returns:

Dict with full server response

Return type:

dict

Notes

Check class docstirng for more info

async aio_captcha_handler(captcha_link: str | None = None, captcha_file: str | None = None, captcha_base64: bytes | None = None, **additional_params) → dict¶

Asynchronous method for captcha solving

Parameters:

captcha_link (str | None) – link to captcha image file
captcha_file (str | None) – path to local captcha image file
captcha_base64 (bytes | None) – captcha image encoded in base64 format
additional_params – Some additional parameters that will be used in creating the task and will be passed to the payload under task key. Like proxyLogin, proxyPassword and etc. - more info in service docs

Returns:

Dict with full server response

Return type:

dict

Notes

Check class docstirng for more info

ImageToTextCaptcha¶

Contents

Navigation