Home / Docs / API reference / get_balance
get_balance
Shows the credits you have left by bucket, your plan and its renewal date, this key's monthly cap and what it has used, and where to buy more. Free, and takes no inputs. Agents can call it before a large search, or after a checkout to see whether the credits have landed.
GET/v1/balanceFree
Request
curl "https://api.whichsitesuse.com/v1/balance" \
-H "Authorization: Bearer $WSU_API_KEY"
Over MCP, call the tool with no arguments.
Response
{
"data": {
"credits": { "total": ..., "plan": ..., "topup": ..., "free": ... },
"plan": {
"id": "growth",
"name": "Growth",
"credits_per_month": 60000,
"renews_at": "YYYY-MM-DDTHH:MM:SSZ"
} | null,
"trial": {
"max_results_per_call": 100,
"calls_per_minute": 30,
"csv_export": false
} | null,
"key": { "name": "...", "monthly_credit_cap": ... | null, "credits_used_this_month": ... },
"buy_credits_url": "https://.../account",
"prices": "Credits: 1 per site in a list, 2 per domain lookup; ..."
},
"meta": { "credits_used": 0, ... }
}
plan is null without a plan, and trial is null once the account has paid for anything.