Меню документації

getBalance: отримати баланс рахунку

Отримати баланс рахунку за допомогою ключа рахунку. Будь ласка, не використовуйте цей метод частіше, ніж раз на 30 секунд, натомість використовуйте кешоване значення в пам’яті/на диску.

Адреса: https://api.anti-captcha.com/getBalance
Метод: POST
Content-type: application-json

Параметри запиту

Властивість Тип Обов’язково Призначення
clientKey Рядок Так

Приклад запиту

CURL
          curl -i -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -X POST -d '{ "clientKey":"YOUR_API_KEY" }' \
https://api.anti-captcha.com/getBalance
        


Структура відповіді

Властивість Тип Призначення
errorId Цілочисельний Ідентифікатор помилки.
0 - без помилок, операція завершена успішно.
>1 - ідентифікатор помилки. Код помилки та короткий опис передано у властивостях errorCode та errorDescription.
errorCode Рядок
errorDescription Рядок Короткий опис помилки
balance Подвійний Баланс рахунку в USD

Приклад відповіді

JSON без помилок
          {
    "errorId": 0,
    "balance": 12.3456
}
        
JSON з помилкою
          {
    "errorId": 1,
    "errorCode": "ERROR_KEY_DOES_NOT_EXIST",
    "errorDescription": "Account authorization key not found in the system"
}