Skip to content
CaptchAPI
API reference

getBalance

Read your wallet balance, tier and current discount.

Returns the wallet balance for the account that owns the key, plus the volume tier that is currently being applied. It is free to call and safe to run on a schedule — a lot of integrations use it as a cheap liveness check.

POST https://api.captchapi.com/getBalance
content-type: application/json
Request
{ "clientKey": "YOUR_API_KEY" }
Response
{
  "errorId": 0,
  "balance": 42.815,
  "currency": "USD",
  "tier": "Silver",
  "discount": 0.1
}

balance is in US dollars as a decimal number. Internally we hold it as integer micro-dollars, so the value you see is exact rather than a rounded float. discount is the fraction taken off list price by your tier: 0.1 means every solve costs 10% less than the published price.

Alert on balance, not on failures. A wallet that hits zero returns ERROR_ZERO_BALANCE on createTask, which looks like an outage in your logs but is a billing event.