Справочник API для решения капчи

POST /createTask Создать задачу

Тело: clientKey и объект task. Остальные поля зависят от типа задачи, смотрите «Типы задач». Ответ: errorId 0 и taskId или errorId 1 с errorCode.

POST https://unlock-api.com/createTask
{"clientKey":"YOUR_API_KEY","task":{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com","websiteKey":"0x4AAAAAAAC3DHQFLr1GavRN"}}

{"errorId":0,"taskId":1001}
{"errorId":1,"errorCode":"ERROR_ZERO_BALANCE","errorDescription":"..."}

POST /getTaskResult Получить результат

Тело: clientKey и taskId. Пока задача выполняется: status processing. Когда готово: status ready с solution и стоимостью. Неудачная задача отвечает errorId 1 со своим errorCode.

POST https://unlock-api.com/getTaskResult
{"clientKey":"YOUR_API_KEY","taskId":1001}

{"errorId":0,"status":"processing"}
{"errorId":0,"status":"ready","solution":{"token":"0.zrSnRHO7h0..."},"cost":"0.0012","createTime":1791640000,"endTime":1791640011,"solveCount":1}

POST /getBalance Получить баланс

Тело: clientKey. Ответ: баланс в долларах США.

{"clientKey":"YOUR_API_KEY"}

{"errorId":0,"balance":42.5}

Сообщить о неверном ответе

reportIncorrectRecaptcha и reportIncorrectImageCaptcha принимают clientKey и taskId и отвечают success. Они поддерживаются для совместимости с существующими библиотеками; жалоба не меняет списание.

Отправить задачу: in.php

Поля: key, method и поля нужного типа капчи. Ответ: OK|ID или с json=1 {"status":1,"request":"ID"}. Ошибки возвращаются своими названиями, например ERROR_ZERO_BALANCE.

POST https://unlock-api.com/in.php
key=YOUR_API_KEY&method=hcaptcha&sitekey=SITE_KEY&pageurl=https://example.com&json=1

OK|1001
{"status":1,"request":"1001"}

Получить ответ: res.php

action=get&id=ID возвращает OK|ANSWER, когда задача решена, и CAPCHA_NOT_READY, пока она в работе. action=get2 добавляет стоимость. ids=ID1,ID2 проверяет до 100 задач за раз. action=getbalance возвращает баланс. action=reportbad и reportgood принимаются.

GET https://unlock-api.com/res.php?key=YOUR_API_KEY&action=get&id=1001
CAPCHA_NOT_READY
OK|P1_eyJ0eXAiOiJKV1Qi...

GET https://unlock-api.com/res.php?key=YOUR_API_KEY&action=getbalance
42.5

POST /getToken Создать и дождаться: getToken

Тело такое же, как у createTask. Вызов ждёт до 50 секунд и возвращает тот же ответ, что и getTaskResult. Если задача ещё выполняется, в ответе будет status processing с её taskId; продолжайте опрашивать getTaskResult.

POST https://unlock-api.com/getToken
{"clientKey":"YOUR_API_KEY","task":{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com","websiteKey":"0x4AAAA..."}}

{"errorId":0,"taskId":1001,"status":"ready","solution":{"token":"0.zrSnRHO7h0..."},"cost":"0.000725"}

Колбэки с результатом

Добавьте callbackUrl в createTask (или pingback в in.php), и результат придёт туда, когда задача завершится: тело в JSON, как у getTaskResult, с taskId, а для in.php тело формы id=…&code=…. Вызываются только публичные адреса, один раз, с таймаутом 5 секунд; результат также остаётся доступным через опрос.

{"clientKey":"YOUR_API_KEY","callbackUrl":"https://your.server/captcha-result","task":{...}}

POST https://your.server/captcha-result
{"errorId":0,"taskId":1001,"status":"ready","solution":{...},"cost":"0.0005"}

Статистика

getQueueStats возвращает число задач в очереди и в работе сейчас и среднее время решения за последний час. getSpendingStats возвращает ваш объём и расходы по часам за одни сутки по UTC (date в формате unix time). test возвращает полученное тело без изменений.

POST https://unlock-api.com/getQueueStats     {"clientKey":"..."}  ->  {"errorId":0,"waiting":3,"solving":12,"speed":6.4,"total":15}
POST https://unlock-api.com/getSpendingStats  {"clientKey":"...","date":1791590400}  ->  {"errorId":0,"data":[{"dateFrom":...,"volume":120,"money":0.06},...]}
POST https://unlock-api.com/test              {"anything":1}  ->  {"errorId":0,"received":{"anything":1}}

Список разрешённых IP

Если на странице аккаунта задан список разрешённых IP, запросы с других IP получают ERROR_IP_NOT_ALLOWED.