Credit balance

GET/api/v1/creditsMCP get_credit_balanceFree

Remaining credits on the account that owns the API key. Never costs a credit.

Parameters

This endpoint takes no parameters.

shell

curl "https://seo-api.org/api/v1/credits" \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns { creditsRemaining }. The CLI's login uses it to check a key.

200 OK

{ "ok": true, "data": { "creditsRemaining": 99 } }

Code	HTTP	Meaning
SEO_API.MISSING_API_KEY	401	No Authorization header or x-api-key header.
SEO_API.INVALID_API_KEY	401	The key does not exist or was revoked.
SEO_API.INVALID_DOMAIN	400	The domain parameter is missing or is not a domain (IPs are rejected).
BILLING.INSUFFICIENT_CREDITS	402	The account has no credits left. Repeat lookups within 24 hours still work.
SYSTEM.INTERNAL_SERVER_ERROR	500	Something failed on our side. Retry with backoff.

SEO_API.MISSING_API_KEY
HTTP401
MeaningNo Authorization header or x-api-key header.
SEO_API.INVALID_API_KEY
HTTP401
MeaningThe key does not exist or was revoked.
SEO_API.INVALID_DOMAIN
HTTP400
MeaningThe domain parameter is missing or is not a domain (IPs are rejected).
BILLING.INSUFFICIENT_CREDITS
HTTP402
MeaningThe account has no credits left. Repeat lookups within 24 hours still work.
SYSTEM.INTERNAL_SERVER_ERROR
HTTP500
MeaningSomething failed on our side. Retry with backoff.

Tool get_credit_balance. Arguments and result match the REST call.

tools/call

{
  "name": "get_credit_balance",
  "arguments": {}
}

terminal

npx @seo-api/cli credits