Index
New Hcaptcha API support
What are "Hcaptcha" challenges?
They`re challenges that typically require the user to align and click on certain images.
For your convenience, we implemented support for Hcaptcha API. If your software works with it, and supports minimal configuration, you should be able to decode Hcaptchas using Death By Captcha in no time.
- Hcaptcha API: Provided a site url and Hcaptcha site key, the API returns a token that you will use to submit the form in the page with the Hcaptcha challenge.
Pricing
For the time being, price is $3.99/1K Hcaptcha challenges correctly solved. You will not be billed for Hcaptcha reported as incorrectly solved. Note that this pricing applies to new Hcaptcha challenges only, so only customers using this specific API will be charged said rate.
Hcaptcha API FAQ:
- What`s the Hcaptcha API URL?
-
To use the Hcaptcha API you will have to send a HTTP POST Request to http://api.dbcapi.me/api/captcha
- What are the POST parameters for the Hcaptcha API?
-
- username: Your DBC account username
- password: Your DBC account password
- type=7: Type 7 specifies this is a Hcaptcha API
- hcaptcha_params=json(payload): the data to access the hcaptcha challenge json payload structure:
-
proxy: your proxy url and credentials (if any).Examples:
- http://127.0.0.1:3128
- http://user:password@127.0.0.1:3128
-
proxytype: your proxy connection protocol. For supported proxy types refer to Which proxy types are supported?. Example:
- HTTP
-
sitekey: the hcaptcha site key of the website with the hcaptcha.
Example:
- 56489210-0c02-58c0-00e5-1763b63dc9d4
You need to locate site key of HCaptcha. You can locate hcaptcha`s div element and check the value of data-sitekey parameter.
- pageurl: the url of the page with the Hcaptcha challenges. This url has to include the path in which the Hcaptcha is loaded. Example: if the Hcaptcha you want to solve is in http://test.com/path1, pageurl has to be http://test.com/path1 and not http://test.com.
The proxy parameter is optional, but we strongly recommend to use one to prevent rejection by the provided page due to inconsistencies between the IP that solved the captcha (ours if no proxy is provided) and the IP that submitted the solution for verification (yours).
Note: if proxy is provided, proxytype is a required parameter.
Full example of hcaptcha_params:
{ 'proxy': 'http://user:password@127.0.0.1:1234', 'proxytype': 'HTTP', 'sitekey': '56489210-0c02-58c0-00e5-1763b63dc9d4', 'pageurl': 'https://testsite.com/xxx-test' }
Full example of hcaptcha_params: with optional rqdata
{ 'proxy': 'http://user:password@127.0.0.1:1234', 'proxytype': 'HTTP', 'sitekey': '56489210-0c02-58c0-00e5-1763b63dc9d4', 'pageurl': 'https://testsite.com/xxx-test' 'rqdata': 'rqdata-parameter-from-site' }
- What`s the response from the Hcaptcha API?
-
The Hcaptcha API response has the following structure. It`s valid for one use and has a 2 minute lifespan. It will be a string like the following:
"P0_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXNza2V5IjoiSm1LUHhreDdsVE lwaWc5cEFuay81cjJ0NE5yVWxrT2lNV0VZQUJ6dmpobkJid29sbFNWKzJiQ0h6cmZ4TGRLU Ww1NEdxcFN0ZzEzT01id1VROXhqYTVDa2d2NjFXSG9YOFNzS2twZU45M0gwRG1RTlQ0Vnlh dnp2T2QxcThFSGlNcVJ1VTZXVEZOMXdGYkdleVpQbllXZ1NRL2FXcjlhUkQyZHNTK2NnL0V 1VGJUam96RWtjMHR3a2tJTk9GcTVuMUdVVXh6b1k0NGpsUHJPaTAyWWRSZ2p3TVFrZXFGQV JFUEFJY3NDbjJEc2Flbzk0V0YzbmtBVWxQd3QxNTdHNUk1ZjFLbnN0S0FLRzVWNy8yUmY4d GdxaTRJZVAwT3o0S200bmlqVC92SHkxdEpQT3Y1N2tMUkVDdzNDU1VMOTc3NXZvdEpuUVBk eUdZVmNxOFptQUZaRTlzQXB2QjllSDE3MTRXcFlhQW1aS1ZZc1B0OHN1Rk0vY1hYVjJabHJ qY1pUeHFONmRPNUFwK0krNVQrZlRQaHBvS0VQeUtWWUI3Rmpkc3BQNWlFeDlIb3ZGWkJqOU pQVHBUa2JNNHJjM0hMVm4zbC9HTmwwRkM5VUM0SzAyVnhjekZnZ2ZlbmprZDdpU3N6dVMva Hp0OFY3elFxYW42cTlGMEpmL01wT3J2cHZDQU9rSnAyb2hiQmx0QlhLSzBGZUt1U2VjQXZn Q2N5Ty9PdWRuWWdvZXFLTTAvVEdnUjByMk10bVZpRlJFZnJ6cVFGNzlNcGE0NkdpMk ..."
- Which proxy types are supported?
-
Currently, only HTTP proxies are supported. Support for other types will be added in the future.
Using Hcaptcha API with api clients:
/**
* Death by Captcha PHP API hcaptcha usage example
*
* @package DBCAPI
* @subpackage PHP
*/
/**
* DBC API clients
*/
require_once '../deathbycaptcha.php';
$username = "username"; // DBC account username
$password = "password"; // DBC account password
$token_from_panel = "your-token-from-panel"; // DBC account authtoken
// Use DeathByCaptcha_SocketClient() class if you want to use SOCKET API.
$client = new DeathByCaptcha_HttpClient($username, $password);
$client->is_verbose = true;
// To use token the first parameter must be authtoken.
// $client = new DeathByCaptcha_HttpClient("authtoken", $token_from_panel);
echo "Your balance is {$client->balance} US cents\n";
// Set the proxy and hcaptcha token data
$data = array(
'proxy' => 'http://user:password@127.0.0.1:1234',
'proxytype' => 'HTTP',
'sitekey' => '56489210-0c02-58c0-00e5-1763b63dc9d4',
'pageurl' => 'https://client-demo.testsite.com/test-hcaptcha'
);
//Create a json string
$json = json_encode($data);
//Put the type and the json payload
$extra = [
'type' => 7,
'hcaptcha_params' => $json,
];
// Put null the first parameter and add the extra payload
if ($captcha = $client->decode(null, $extra)) {
echo "CAPTCHA {$captcha['captcha']} uploaded\n";
sleep(DeathByCaptcha_Client::DEFAULT_TIMEOUT);
// Poll for CAPTCHA indexes:
if ($text = $client->get_text($captcha['captcha'])) {
echo "CAPTCHA {$captcha['captcha']} solved: {$text}\n";
// Report an incorrectly solved CAPTCHA.
// Make sure the CAPTCHA was in fact incorrectly solved!
//$client->report($captcha['captcha']);
}
}
# hcaptcha
import deathbycaptcha
import json
# Put your DBC account username and password here.
username = "username"
password = "password"
# you can use authtoken instead of user/password combination
# activate and get the authtoken from DBC users panel
authtoken = "authtoken"
# to use socket client
# client = deathbycaptcha.SocketClient(username, password)
# to use authtoken
# client = deathbycaptcha.SocketClient(username, password, authtoken)
client = deathbycaptcha.HttpClient(username, password)
# Put the proxy and hcaptcha data
Captcha_dict = {
'proxy': 'http://user:password@127.0.0.1:1234',
'proxytype': 'HTTP',
'sitekey': '56489210-0c02-58c0-00e5-1763b63dc9d4',
'pageurl': 'https://client-demo.testsite.com/test-hcaptcha'
}
# Create a json string
json_Captcha = json.dumps(Captcha_dict)
try:
balance = client.get_balance()
print(balance)
# Put your CAPTCHA type and Json payload here:
captcha = client.decode(type=7, hcaptcha_params=json_Captcha)
if captcha:
# The CAPTCHA was solved; captcha["captcha"] item holds its
# numeric ID, and captcha["text"] its text token solution.
print("CAPTCHA %s solved: %s" % (captcha["captcha"], captcha["text"]))
if '': # check if the CAPTCHA was incorrectly solved
client.report(captcha["captcha"])
except deathbycaptcha.AccessDeniedException:
# Access to DBC API denied, check your credentials and/or balance
print("error: Access to DBC API denied, check your credentials and/or balance")
import com.DeathByCaptcha.AccessDeniedException;
import com.DeathByCaptcha.Client;
import com.DeathByCaptcha.HttpClient;
import com.DeathByCaptcha.SocketClient;
import com.DeathByCaptcha.Captcha;
import org.json.JSONObject;
import java.io.IOException;
class ExampleHcaptcha {
public static void main(String[] args)
throws Exception {
// Put your DBC username & password or authtoken here:
String username = "your_username_here";
String password = "your_password_here";
String authtoken = "your_authtoken_here";
/* Death By Captcha Socket Client
Client client = (Client) (new SocketClient(username, password));
Death By Captcha http Client */
Client client = (Client) (new HttpClient(username, password));
client.isVerbose = true;
/* Using authtoken
Client client = (Client) new HttpClient(authtoken); */
try {
try {
System.out.println("Your balance is " + client.getBalance()
+ " US cents");
} catch (IOException e) {
System.out.println("Failed fetching balance: " + e.toString());
return;
}
Captcha captcha = null;
try {
// Proxy and hcaptcha data
String proxy = "http://user:password@127.0.0.1:1234";
String proxytype = "http";
String sitekey = "029EF0D3-41DE-03E1-6971-466539B47725";
String pageurl = "https://client-demo.testsite.com/test-funcaptcha";
/* Upload a hcaptcha and poll for its status with 120 seconds timeout.
Put your proxy, proxy type, page sitekey, page url and solving
timeout (in seconds) 0 or nothing for the default timeout value. */
captcha = client.decode(7, proxy, proxytype, sitekey, pageurl);
//other method is to send a json with the parameters
/*
JSONObject json_params = new JSONObject();
json_params.put("proxy", proxy);
json_params.put("proxytype", proxytype);
json_params.put("sitekey", sitekey);
json_params.put("pageurl", pageurl);
captcha = client.decode(7, json_params);
*/
} catch (IOException e) {
System.out.println("Failed uploading CAPTCHA");
return;
}
if (null != captcha) {
System.out.println("CAPTCHA " + captcha.id + " solved: "
+ captcha.text);
/* Report incorrectly solved CAPTCHA if necessary.
Make sure you've checked if the CAPTCHA was in fact incorrectly
solved, or else you might get banned as abuser. */
/*try {
if (client.report(captcha)) {
System.out.println("Reported as incorrectly solved");
} else {
System.out.println(
"Failed reporting incorrectly solved CAPTCHA");
}
} catch (IOException e) {
System.out.println(
"Failed reporting incorrectly solved CAPTCHA:" + e.toString());
}*/
} else {
System.out.println("Failed solving CAPTCHA");
}
} catch (com.DeathByCaptcha.Exception e) {
System.out.println(e);
}
}
}
// hcaptcha
using System;
using System.Collections;
using DeathByCaptcha;
namespace DBC_Examples.examples
{
public class HcaptchaExample
{
public void Main()
{
// Put your DeathByCaptcha account username and password here.
string username = "your username";
string password = "your password";
// string token_from_panel = "your-token-from-panel";
/* Death By Captcha Socket Client
Client client = (Client) new SocketClient(username, password);
Death By Captcha http Client */
Client client = (Client) new HttpClient(username, password);
/* To use token authentication the first parameter must
be "authtoken".
Client client = (Client) new HttpClient("authtoken",
token_from_panel); */
// Put your Proxy credentials and type here
string proxy = "http://user:password@127.0.0.1:1234";
string proxyType = "HTTP";
string sitekey = "56489210-0c02-58c0-00e5-1763b63dc9d4";
string pageurl = "https://client-demo.testsite.com/test-hcaptcha";
string hcaptchaParams = "{\"proxy\": \"" + proxy + "\"," +
"\"proxytype\": \"" + proxyType + "\"," +
"\"sitekey\": \"" + sitekey + "\"," +
"\"pageurl\": \"" + pageurl + "\"}";
try
{
double balance = client.GetBalance();
/* Upload a CAPTCHA and poll for its status. Put the hCaptcha
Json payload, CAPTCHA type and desired solving timeout
(in seconds) here. If solved, you'll receive a
DeathByCaptcha.Captcha object. */
Captcha captcha = client.Decode(Client.DefaultTimeout,
new Hashtable()
{
{"type", 7},
{"hcaptcha_params", hcaptchaParams}
});
if (null != captcha)
{
/* The CAPTCHA was solved; captcha.Id property holds
its numeric ID, and captcha.Text holds its text. */
Console.WriteLine("CAPTCHA {0} solved: {1}",
captcha.Id, captcha.Text);
// if ( /* check if the CAPTCHA was incorrectly solved */)
// {
// client.Report(captcha);
// }
}
}
catch (AccessDeniedException e)
{
/* Access to DBC API denied,
check your credentials and/or balance */
Console.WriteLine("<<< catch : " + e.ToString());
}
}
}
}
Imports DeathByCaptcha
Public Class Hcaptcha
Sub Main(args As String())
' Put your DBC username & password or authtoken here:
Dim username = "username"
Dim password = "password"
Dim token_from_panel = "your-token-from-panel"
' DBC Socket API client
' Dim client As New SocketClient(username, password)
' DBC HTTP API client
Dim client As New HttpClient(username, password)
' To use token auth the first parameter must be "authtoken"
' Dim client As New HttpClient("authtoken", token_from_panel)
' Proxy and hcaptcha data
Dim proxy = "http://user:password@127.0.0.1:1234"
Dim proxyType = "HTTP"
Dim sitekey = "56489210-0c02-58c0-00e5-1763b63dc9d4"
Dim pageurl = "https://client-demo.testsite.com/test-hcaptcha"
Console.WriteLine(String.Format("Your balance is {0,2:f} US cents",
client.Balance))
' Create a JSON with the extra data
Dim hcaptchaParams = "{""proxy"": """ + proxy + """," +
"""proxytype"": """ + proxyType + """," +
"""sitekey"": """ + sitekey + """," +
"""pageurl"": """ + pageurl + """}"
' Create the payload with the type and the extra data
Dim extraData As New Hashtable()
extraData.Add("type", 7)
extraData.Add("hcaptcha_params", hcaptchaParams)
' Upload a CAPTCHA and poll for its status. Put the hCaptcha
' Json payload, CAPTCHA type and desired solving timeout (in seconds)
' here. If solved, you'll receive a DeathByCaptcha.Captcha object.
Dim captcha As Captcha = client.Decode(
DeathByCaptcha.Client.DefaultTimeout, extraData)
If captcha IsNot Nothing Then
Console.WriteLine(String.Format("CAPTCHA {0:d} solved: {1}",
captcha.Id, captcha.Text))
' Report an incorrectly solved CAPTCHA.
' Make sure the CAPTCHA was in fact incorrectly solved, do not
' just report it at random, or you might be banned as abuser.
' If client.Report(captcha) Then
' Console.WriteLine("Reported as incorrectly solved")
' Else
' Console.WriteLine("Failed reporting as incorrectly solved")
' End If
End If
End Sub
End
/*
* Death by Captcha Node.js API hcaptcha usage example
*/
const dbc = require('../deathbycaptcha');
const username = 'username'; // DBC account username
const password = 'password'; // DBC account password
const token_from_panel = 'your-token-from-panel'; // DBC account authtoken
// Proxy and hcaptcha token data
const hcaptcha_params = JSON.stringify({
'proxy': 'http://username:password@proxy.example:3128',
'proxytype': 'HTTP',
'sitekey': '56489210-0c02-58c0-00e5-1763b63dc9d4',
'pageurl': 'https://client-demo.testsite.com/test-hcaptcha'
});
// Death By Captcha Socket Client
// const client = new dbc.SocketClient(username, password);
// Death By Captcha http Client
const client = new dbc.HttpClient(username, password);
// To use token authentication the first parameter must be "authtoken"
// const client = new dbc.HttpClient("authtoken", token_from_panel);
// Get user balance
client.get_balance((balance) => {
console.log(balance);
});
// Solve captcha with type 7 & token_params extra arguments
client.decode({extra: {type: 7, hcaptcha_params: hcaptcha_params}},
(captcha) => {
if (captcha) {
console.log('Captcha ' + captcha['captcha'] + ' solved: '
+ captcha['text']);
/*
* Report an incorrectly solved CAPTCHA.
* Make sure the CAPTCHA was in fact incorrectly solved!
* client.report(captcha['captcha'], (result) => {
* console.log('Report status: ' + result);
* });
*/
}
});