getBalance 查询余额

getBalance 返回账户的剩余点数（1 元 = 1000 点），以及开发者分成和邀请奖励的余额（元）。不扣点，常用来确认 clientKey 是否正确。

POSThttps://api.yescaptcha.com/getBalance国际节点复制

POSThttps://cn.yescaptcha.com/getBalance国内节点复制

请求参数

字段	类型	必填	说明
clientKey	string	是	账户密钥

{ "clientKey": "YOUR_CLIENT_KEY" }

返回结果

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

字段	类型	说明
balance	integer	账户余额，单位是点（1 元 = 1000 点）。必须大于 10 点才能创建任务
softBalance	number	开发者分成余额，单位是元，见 开发者分成
inviteBalance	number	邀请奖励余额，单位是元，见 邀请奖励
inviteBy	integer	邀请你注册的人的用户 ID，没有时为 0

clientKey 不对时返回 ERROR_KEY_DOES_NOT_EXIST。getBalance 受 自动暂停 影响：暂停期间返回 ERROR_IP_BLOCKED_5MIN。

示例

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