getBalance – Guthaben abfragen

getBalance liefert die verbleibenden Punkte des Kontos (1,000 Punkte = ¥1) sowie das Guthaben aus Entwicklerbeteiligung und Empfehlungsprämien (in ¥). Es erfolgt kein Punkteabzug, daher eignet sich die Abfrage gut, um zu prüfen, ob der clientKey korrekt ist.

POSThttps://api.yescaptcha.com/getBalanceGlobaler EndpointKopieren

POSThttps://cn.yescaptcha.com/getBalanceChina-EndpointKopieren

Anfrageparameter

Feld	Typ	Pflicht	Beschreibung
clientKey	string	Ja	Kontoschlüssel (ClientKey)

{
  "clientKey": "YOUR_CLIENT_KEY"
}

Rückgabe

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

Feld	Typ	Beschreibung
balance	integer	Kontoguthaben in Punkten (1,000 Punkte = ¥1). Zum Erstellen von Aufgaben muss es über 10 Punkten liegen
softBalance	number	Guthaben aus der Entwicklerbeteiligung in ¥, siehe Entwicklerbeteiligung
inviteBalance	number	Guthaben aus Empfehlungsprämien in ¥, siehe Empfehlungsprämie
inviteBy	integer	Benutzer-ID der Person, die Sie eingeladen hat; 0, wenn es keine gibt
keyQuotaRemaining	integer	Verbleibendes Ausgabenlimit dieses clientKey im aktuellen Zeitraum, in Punkten. Dieses Feld gibt es nur bei einem clientKey mit Limit; balance ist dann der kleinere Wert aus Kontoguthaben und verbleibendem Limit. Ohne Limit fehlt das Feld

Bei einem falschen clientKey wird ERROR_KEY_DOES_NOT_EXIST zurückgegeben. Ist für den clientKey eine IP-Whitelist gesetzt und die anfragende IP nicht darin enthalten, wird ERROR_KEY_IP_NOT_ALLOWED zurückgegeben. getBalance unterliegt der automatischen Pausierung: Während der Pausierung wird ERROR_IP_BLOCKED_5MIN zurückgegeben.

Beispiele

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