getBalance 残高の照会

getBalance はアカウントの残りポイント(1,000 ポイント = ¥1)と、開発者収益分配および紹介報酬の残高(元)を返します。課金されないため、clientKey が正しいかどうかの確認によく使われます。

POSThttps://api.yescaptcha.com/getBalanceグローバルエンドポイントコピー

POSThttps://cn.yescaptcha.com/getBalance中国エンドポイントコピー

リクエストパラメータ

フィールド	型	必須	説明
clientKey	string	はい	アカウントの clientKey

{
  "clientKey": "YOUR_CLIENT_KEY"
}

レスポンス

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

フィールド	型	説明
balance	integer	アカウントの残高。単位はポイント(1,000 ポイント = ¥1)。タスクを作成するには 10 ポイントを超えている必要があります
softBalance	number	開発者収益分配の残高。単位は元。開発者収益分配を参照してください
inviteBalance	number	紹介報酬の残高。単位は元。紹介報酬を参照してください
inviteBy	integer	あなたを招待したユーザーのユーザー ID。いない場合は 0
keyQuotaRemaining	integer	この clientKey の今期の残り利用上限。単位はポイント。上限を設定した clientKey にのみ含まれ、その場合 balance はアカウント残高と残り上限のうち小さいほうになります。上限を設定していない場合、このフィールドは含まれません

clientKey が正しくない場合は ERROR_KEY_DOES_NOT_EXIST が返ります。clientKey に IP ホワイトリストが設定されていて、リクエスト元の IP がその中にない場合は ERROR_KEY_IP_NOT_ALLOWED が返ります。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);
}