Developed by Infosimples, a brazilian company that offers data extraction solutions.
We suggest you to also check 2Captcha.com for a cheaper service. You can find it's gem fully compatible with the deathbycaptcha gem at https://github.com/infosimples/two_captcha.
Contact us if you need enterprise services for CAPTCHAs solving or Internet automation.
DeathByCaptcha is a Ruby API for DeathByCaptcha - http://www.deathbycaptcha.com.
Add this line to your application's Gemfile:
gem 'deathbycaptcha', '~> 5.0.0'And then execute:
$ bundle
Or install it yourself as:
$ gem install deathbycaptcha
- Create a client
# Create a client (:socket and :http clients are available)
client = DeathByCaptcha.new('myusername', 'mypassword', :http)- Solve a captcha
There are two methods available: decode and decode! * decode doesn't raise exceptions. * decode! may raise a DeathByCaptcha::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 DeathByCaptcha
captcha.is_correct # true if the solution is correctYou 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 any image to raw64 (binary base64 encoded).
- Retrieve a previously solved captcha
captcha = client.captcha('130920620') # with 130920620 as the captcha id- Report incorrectly solved captcha for refund
captcha = client.report!('130920620') # with 130920620 as the captcha idWarning: do not abuse on this method, otherwise you may get banned
- Retrieve your user information (which has the current credit balance)
user = client.user()
user.is_banned # true if the user is banned
user.balance # Credit balance in US cents
user.rate # Captcha rate, i.e. charges for one solved captcha in US cents
user.id # Numeric ID of your account- Retrieve DeathByCaptcha server status
status = client.status()
status.todays_accuracy # Current accuracy of DeathByCaptcha
status.solved_in # Estimated seconds to solve a captcha right now
status.is_service_overloaded # true if DeathByCaptcha is overloaded/unresponsiveIt's currently available only with the :http client.
To solve captchas similar to reCAPTCHA v2, you can use both the DeathByCaptcha's Coordinates API or Image Group API.
Please, read the oficial documentation at http://www.deathbycaptcha.com/user/api/newrecaptcha.
# Read above all the instructions on how to solve a captcha.
captcha = client.decode!(type: 2, url: 'http://bit.ly/1VCUuzk')You should specify arguments with type = 2 and an image similar to a screenshot of the captcha. See an example:
Captcha (screenshot)
the argument is passed as url, path, file, raw or raw64
The response will be an array containing coordinates (x, y) where the human clicked to solve the captcha. For the captcha above it should look something like:
# captcha.text
"[[30,143],[241,325]]"
# captcha.coordinates
[[30, 143], [241, 325]]# Read above all the instructions on how to solve a captcha.
captcha = client.decode!(
type: 3,
url: 'http://bit.ly/1i1CIaB', # single image with the clickable grid
banner: { url: 'http://bit.ly/1JTG4T3' }, # the banner image
banner_text: 'Click all images with bananas' # the banner text
)You should specify arguments with type = 3 and the decomposed captcha as seen in the example below:
Captcha: images grid
the argument is passed as url, path, file, raw or raw64
Captcha: banner
Captcha: banner text
Click all images with bananas
The response will be an array containing the indexes for each image that should be clicked counting from left to right. For the captcha above it should look something like:
# captcha.text
"[1,9]"
# captcha.indexes
[1, 9]It's currently available only with the :http client.
To solve captchas similar to reCAPTCHA v2, you can also use Token API
Please, read the oficial documentation at http://deathbycaptcha.com/user/api/newtokenrecaptcha
# Read above all the instructions on how to solve a captcha.
captcha = client.decode!(type: 4, token_params: {
# optional proxy if needed and server verifies
#proxy: "http://127.0.0.1:3128",
#proxytype: "HTTP",
googlekey: "6Ld2sf4SAAAAAKSgzs0Q13IZhY02Pyo31S2jgOB5",
pageurl: "https://patrickhlauke.github.io/recaptcha/"
})You should specify arguments with type = 4 and an all token params required by DBC API
The response will be a text (token), which you can access with text or token method.
# captcha.text
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd
saD2H0e6S3547xi1FlqJB4rob46J0-wfZMj6YpyVa0WGCfpWzBWcLn7tO_EYs
vEC_3kfLNINWa5LnKrnJTDXTOz-JuCKvEXx0EQqzb0OU4z2np4uyu79lc_Ndv
L0IRFc3Cslu6UFV04CIfqXJBWCE5MY0Ag918r14b43ZdpwHSaVVrUqzCQMCyb
cGq0yxLQf9eSexFiAWmcWLI5nVNA81meTXhQlyCn5bbbI2IMSEErDqceZjf1m
X3M67BhIb4"
# captcha.token
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd
saD2H0e6S3547xi1FlqJB4rob46J0-wfZMj6YpyVa0WGCfpWzBWcLn7tO_EYs
vEC_3kfLNINWa5LnKrnJTDXTOz-JuCKvEXx0EQqzb0OU4z2np4uyu79lc_Ndv
L0IRFc3Cslu6UFV04CIfqXJBWCE5MY0Ag918r14b43ZdpwHSaVVrUqzCQMCyb
cGq0yxLQf9eSexFiAWmcWLI5nVNA81meTXhQlyCn5bbbI2IMSEErDqceZjf1m
X3M67BhIb4"Those captchas sometimes took more than 60 seconds to solve So consider increasing the client's timeout
The API is thread-safe, which means it is perfectly fine to share a client instance between multiple threads.
The API supports HTTP and socket-based connections, with the latter being recommended for having faster responses and overall better performance. The two clients have the same methods/interface.
When using the socket client, make sure that outgoing TCP traffic to api.dbcapi.me to the ports in range 8123-8130 is not blocked by your firewall.
We are currently suggesting developers to use HTTP connection because Socket seems to be unstable with older Ruby versions. While we are investigating, consider using only HTTP connection.
DeathByCaptcha >= 5.0.0 don't require specific dependencies. That saves you memory and avoid conflicts with other gems.
Any format you use in the decode method (url, file, path, raw, raw64) will always be converted to a raw64, which is a binary base64 encoded string. So, if you already have this format available on your side, there's no need to do convertions before calling the API.
Our recomendation is to never convert your image format, unless needed. Let the gem convert internally. It may save you resources (CPU, memory and IO).
We no longer follow the versioninig system of the official clients of DeathByCaptcha. We have bumped to version 5.0.0 and will use Semantic Versioning from now on.
Any 5.x version is incompatible with any 4.x version. Please, review your code before upgrading.
This gem has been tested on the following versions of Ruby:
- MRI 2.2.0
- MRI 2.1.5
- MRI 2.0.0
- MRI 1.9.3
- Fork it ( https://github.com/infosimples/deathbycaptcha/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Run/add tests (RSpec)
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
- Yay. Thanks for contributing :)
All contributors: https://github.com/infosimples/deathbycaptcha/graphs/contributors
MIT License. Copyright (C) 2011-2015 Infosimples. https://infosimples.com/