API credit balance
get_api_credit_balanceAPI credit balance: prepaid credits left for SEO data calls, amount spent, whether spending is suspended, and the per-call pricing rule. Free; no supplier call.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_api_credit_balance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| packs | No | API credit packs the account owner can buy, smallest first. | |
| frozen | Yes | True when spending is suspended after a refund or dispute. | |
| pricing | Yes | ||
| creditsUrl | No | Dashboard page where the account owner buys API credits. | |
| historyUrl | No | Dashboard page listing this account's data calls and costs. | |
| spentMicros | Yes | ||
| availableUsd | Yes | ||
| creditsNotice | No | Low API credit balance: tell the user once, with this link to add credits. Never open it automatically. | |
| availableMicros | Yes | ||
| dataCallsEnabled | Yes | False until SEO data calls are switched on for this deployment. |