Ruby API for TwoCaptcha (Captcha Solver as a Service
Usage
Create a client
# Create a client
client = TwoCaptcha.new('my_captcha_key')
Solve a captcha
There are two methods available: decode and decode!
decode doesn't raise exceptions.
decode! may raise a TwoCaptcha::Error if something goes wrong.
If the solution is not available, an empty captcha object will be returned.
captcha = client.decode!(url: 'http://bit.ly/1xXZcKo')
captcha.text # Solution of the captcha
captcha.id # Numeric ID of the captcha solved by TwoCaptcha
You can also specify path, file, raw and raw64 when decoding an image.
client.decode(path: 'path/to/my/captcha/file')
client.decode(file: File.open('path/to/my/captcha/file', 'rb'))
client.decode(raw: File.open('path/to/my/captcha/file', 'rb').read)
client.decode(raw64: Base64.encode64(File.open('path/to/my/captcha/file', 'rb').read))
Internally, the gem will always convert the image to raw64 (binary base64 encoded).
You may also specify any POST parameters specified at https://2captcha.com/setting.
Retrieve a previously solved captcha
captcha = client.captcha('130920620') # with 130920620 as the captcha id
Report incorrectly solved captcha for refund
client.report!('130920620') # with 130920620 as the captcha id
# return true if successfully reported
Warning: do not abuse on this method, otherwise you may get banned
Get your balance on 2Captcha
client.balance
# return a Float balance in USD.
Get usage statistics for a specific date
client.stats('2015-08-05')
# return an XML string with your usage statistics.
Get current 2Captcha load
client.load
# return an XML string with the current service load.
New ReCaptcha
To solve captchas similar to reCAPTCHA v2, you can add the param 'id_constructor: 23' to your request.
Please read the oficial documentation at https://2captcha.com/support/faq/30/ for more information.
client.decode(url: 'http://bit.ly/1xXZcKo', id_constructor: 23)
Captcha (screenshot)
Create a client
# Create a client
client = TwoCaptcha.new('my_captcha_key')
Solve a captcha
There are two methods available: decode and decode!
decode doesn't raise exceptions.
decode! may raise a TwoCaptcha::Error if something goes wrong.
If the solution is not available, an empty captcha object will be returned.
captcha = client.decode!(url: 'http://bit.ly/1xXZcKo')
captcha.text # Solution of the captcha
captcha.id # Numeric ID of the captcha solved by TwoCaptcha
You can also specify path, file, raw and raw64 when decoding an image.
client.decode(path: 'path/to/my/captcha/file')
client.decode(file: File.open('path/to/my/captcha/file', 'rb'))
client.decode(raw: File.open('path/to/my/captcha/file', 'rb').read)
client.decode(raw64: Base64.encode64(File.open('path/to/my/captcha/file', 'rb').read))
Internally, the gem will always convert the image to raw64 (binary base64 encoded).
You may also specify any POST parameters specified at https://2captcha.com/setting.
Retrieve a previously solved captcha
captcha = client.captcha('130920620') # with 130920620 as the captcha id
Report incorrectly solved captcha for refund
client.report!('130920620') # with 130920620 as the captcha id
# return true if successfully reported
Warning: do not abuse on this method, otherwise you may get banned
Get your balance on 2Captcha
client.balance
# return a Float balance in USD.
Get usage statistics for a specific date
client.stats('2015-08-05')
# return an XML string with your usage statistics.
Get current 2Captcha load
client.load
# return an XML string with the current service load.
New ReCaptcha
To solve captchas similar to reCAPTCHA v2, you can add the param 'id_constructor: 23' to your request.
Please read the oficial documentation at https://2captcha.com/support/faq/30/ for more information.
client.decode(url: 'http://bit.ly/1xXZcKo', id_constructor: 23)
Captcha (screenshot)