getBalance — consultar saldo

getBalance retorna os pontos restantes da conta (1,000 pontos = ¥1) e os saldos de participação do desenvolvedor e de recompensa por indicação (em yuan). Não cobra pontos e costuma ser usado para confirmar se a clientKey está correta.

POSThttps://api.yescaptcha.com/getBalanceEndpoint globalCopiar

POSThttps://cn.yescaptcha.com/getBalanceEndpoint ChinaCopiar

Parâmetros da requisição

Campo	Tipo	Obrigatório	Descrição
clientKey	string	Sim	Chave da conta

{
  "clientKey": "YOUR_CLIENT_KEY"
}

Resposta

{
  "errorId": 0,
  "balance": 1071810,
  "softBalance": 36.0098,
  "inviteBalance": 0,
  "inviteBy": 0
}

Campo	Tipo	Descrição
balance	integer	Saldo da conta, em pontos (1,000 pontos = ¥1). Precisa ser maior que 10 pontos para criar tarefas
softBalance	number	Saldo de participação do desenvolvedor, em yuan; veja Participação do desenvolvedor
inviteBalance	number	Saldo de recompensa por indicação, em yuan; veja Recompensa por indicação
inviteBy	integer	ID de usuário de quem indicou você para o cadastro; 0 se não houver
keyQuotaRemaining	integer	Limite de gastos restante desta clientKey no período atual, em pontos. Só existe para uma clientKey com limite definido; nesse caso, balance é o menor valor entre o saldo da conta e o limite restante. Uma clientKey sem limite não tem este campo

Uma clientKey incorreta retorna ERROR_KEY_DOES_NOT_EXIST; se a clientKey tem uma lista de IPs permitidos e a requisição vem de um IP fora dela, retorna ERROR_KEY_IP_NOT_ALLOWED. O getBalance é afetado pela pausa automática: durante a pausa, retorna ERROR_IP_BLOCKED_5MIN.

Exemplos

curl

get-balance.sh

#!/usr/bin/env bash
# Check the balance. getBalance is free and is a quick way to verify your clientKey
set -euo pipefail
curl -s https://api.yescaptcha.com/getBalance \
  -H 'Content-Type: application/json' \
  -d "{\"clientKey\": \"${YESCAPTCHA_CLIENT_KEY}\"}"
echo

Python

get_balance.py

"""Check the balance. getBalance is free and is a quick way to verify your clientKey."""
import os

import requests

CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"]

r = requests.post(
    "https://api.yescaptcha.com/getBalance",
    json={"clientKey": CLIENT_KEY},
    timeout=30,
)
data = r.json()
if data.get("errorId"):
    # e.g. ERROR_KEY_DOES_NOT_EXIST when the clientKey is wrong
    print("error:", data.get("errorCode"), data.get("errorDescription"))
else:
    print("balance (points):", data["balance"])

Node.js

get-balance.mjs

// Check the balance. getBalance is free and is a quick way to verify your clientKey. Node.js 18+
const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY;

const res = await fetch('https://api.yescaptcha.com/getBalance', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ clientKey: CLIENT_KEY }),
});
const data = await res.json();
if (data.errorId) {
  // e.g. ERROR_KEY_DOES_NOT_EXIST when the clientKey is wrong
  console.log('error:', data.errorCode, data.errorDescription);
} else {
  console.log('balance (points):', data.balance);
}