Balance API

The prepaid balance and what is held for tasks in progress.

Every operation of the API reference is generated from the contract the API serves, version 0.1.0. Replace YOUR_API_KEY in the samples with your key.

Get the balance

GET/v1/balance

The available balance and what is held for tasks in progress.

Authentication: Your API key, as a bearer token: Authorization: Bearer YOUR_API_KEY.

Responses

Responses of Get the balance

Status	Meaning	Body
200 OK	The balance.	Balance (application/json)
429 Too Many Requests	Over a budget for reading (rate_limited); retry after Retry-After.	Problem (application/problem+json)
Any other status	An error, as RFC 9457 problem details.	Problem (application/problem+json)

Error codes

rate_limited. The errors reference says what each means, whether a retry helps and what it costs.

Sample

curl

curl https://api.zerocaptcha.io/v1/balance \
  -H "Authorization: Bearer YOUR_API_KEY"

Node

request.mjs

const response = await fetch("https://api.zerocaptcha.io/v1/balance", {
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
  },
});
console.log(response.status, await response.text());

Python

request.py

import requests

response = requests.get(
    "https://api.zerocaptcha.io/v1/balance",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code, response.text)