Task

Create a Task without proxy

Curl

curl --location --request POST 'https://api.hardcaptcha.com/tasks/' \
--header 'x-api-key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data '{
  "type": "FUNCAPTCHA",
  "data": {
      "websiteUrl": "https://example.com",
      "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB"
  }
}'

Python

import requests
import json

url = "api.hardcaptcha.com/app/tasks/"

payload = json.dumps({
  "type": "FUNCAPTCHA",
  "data": {
    "websiteUrl": "https://example.com",
    "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB"
  }
})
headers = {
  'x-api-key': '<your_api_key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

NodeJS

const axios = require('axios');
let data = JSON.stringify({
  "type": "FUNCAPTCHA",
  "data": {
    "websiteUrl": "https://example.com",
    "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB"
  }
});

let config = {
  method: 'post',
  url: 'api.hardcaptcha.com/app/tasks/',
  headers: { 
    'x-api-key': '<your_api_key>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Create a Task with proxy

Curl

curl --location --request POST 'api.hardcaptcha.com/tasks/' \
--header 'x-api-key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data '{
   "type": "FUNCAPTCHA",
   "useProxy": true,
   "data": {
    "proxy": "host:port:user:password",
    "proxyType": "socks5",
    "data": "whatever_you_want. ex: blob....",
    "websiteUrl": "1",
    "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB",
  }
}'

Python

import requests
import json

url = "api.hardcaptcha.com/app/tasks/"

payload = json.dumps({
  "type": "FUNCAPTCHA",
  "useProxy": True,
  "data": {
    "proxy": "host:port:user:password",
    "data": "whatever_you_want. ex: blob....",
    "websiteUrl": "1",
    "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB",
    "proxyType": "socks5"
  }
})
headers = {
  'x-api-key': '<your_api_key>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

NodeJS

const axios = require('axios');
let data = JSON.stringify({
  "type": "FUNCAPTCHA",
  "useProxy": true,
  "data": {
    "proxy": "host:port:user:password",
    "data": "whatever_you_want. ex: blob....",
    "websiteUrl": "1",
    "websiteKey": "2CB16598-CB82-4CF7-B332-5990DB66F3AB",
    "proxyType": "socks5"
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'api.hardcaptcha.com/app/tasks/',
  headers: { 
    'x-api-key': '<your_api_key>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Get task result

GET/tasks/{id}

Path parameters

id*string

Task id

Query parameters

Response

200403

Body

application/json

id*string

Task Id

Example: "653f3367135713a0efbb6046"

result*GetTaskResultResponseDto (object)

status*enum

PENDINGPROCESSINGSUCCESSFAILED

Request

JavaScriptCurlPython

const response = await fetch('/tasks/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "id": "653f3367135713a0efbb6046",
  "result": {
    "token": "03AFcWeA5WeEs4O_OvnKLw-o3WTvI9skoEHcfsb7UG9-ldLUpwUuDyrsaEalbQMMh4x-_sP-IuO_frKHQw1Cdg6ATz4OSwckqD6qCPOVp1Jbimnj9cQKUTJ-DpzuVrOaIq8PKEY8wnVohZld0W5y2JqybwRpYUiMS9wBtx3oQIx6xsjPdoWiW5D445DUIzfcyyZ6fl70KqiVtZDsLpg0B9Y6RrO1svCcNB3IAZTHDXzpDDhMgq2LFh_dYyun_6ldVIQAVCm5EufNM8SuAs5IZe4ambLtpFWl2EEAIel_TdGhUOoL_jjbmwt2IdGZGoo_KcAErTb79zBPyU6-hC9VJHJpsf1P73-2qRLP4driJ-x_D4KJPINk5fJ3dbcDj8M4yxQg7HZt4R52MGysmH8M8U4tHL0ygFNz-d_iMEYpZjbQ-dWk65DsH73voTL54foKnodAmHs4xUXK2zla6hjzdyK383qwtHVVrQJYLeFjzNfZg8S7NiKfoKx1jHLlEs7HCfgpc8gZLiXo4vVqNXy1-KAj_kbzIlRr6-2COXIlRTAhPM-5zbfLwc6Gsf0vnm4U8MDsnJGyggDtNH"
  },
  "status": "PENDING"
}