getBalance: consultar el saldo

getBalance devuelve los puntos restantes de la cuenta (1,000 puntos = ¥1), así como los saldos de participación del desarrollador y de recompensa por referidos (en yuanes). No cobra puntos y se usa a menudo para confirmar que clientKey es correcta.

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

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

Parámetros de la solicitud

Campo	Tipo	Obligatorio	Descripción
clientKey	string	Sí	ClientKey de la cuenta

{
  "clientKey": "YOUR_CLIENT_KEY"
}

Respuesta

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

Campo	Tipo	Descripción
balance	integer	Saldo de la cuenta, en puntos (1,000 puntos = ¥1). Debe ser mayor que 10 puntos para crear tareas
softBalance	number	Saldo de participación del desarrollador, en yuanes; consulta participación del desarrollador
inviteBalance	number	Saldo de recompensa por referidos, en yuanes; consulta recompensa por referidos
inviteBy	integer	ID de usuario de quien te invitó a registrarte; 0 si no hay
keyQuotaRemaining	integer	Límite de gasto restante de esta clientKey en el periodo actual, en puntos. Solo aparece en las clientKey que tienen un límite configurado; en ese caso balance es el menor entre el saldo de la cuenta y el límite restante. Las que no tienen límite no incluyen este campo

Si clientKey es incorrecta, se devuelve ERROR_KEY_DOES_NOT_EXIST; si la clientKey tiene una lista blanca de IP y la solicitud proviene de una IP que no está en ella, se devuelve ERROR_KEY_IP_NOT_ALLOWED. getBalance se ve afectado por la pausa automática: durante la pausa devuelve ERROR_IP_BLOCKED_5MIN.

Ejemplos

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);
}