Skip to main content
GET
/
v1
/
account
/
me
Get Account Info
curl --request GET \
  --url https://scrapebadger.com/v1/account/me \
  --header 'x-api-key: <api-key>'
{
  "credits_balance": 50000,
  "subscription_credits_balance": 250000,
  "total_credits_balance": 300000,
  "tier": "pro",
  "rate_limit_per_minute": 1000,
  "subscription": {
    "plan_code": "growth",
    "plan_title": "Growth",
    "billing_cadence": "monthly",
    "status": "active",
    "current_period_start": "2026-05-01T00:00:00Z",
    "current_period_end": "2026-06-01T00:00:00Z",
    "cancel_at_period_end": false,
    "cancel_effective_at": null,
    "monthly_credits": 500000,
    "pending_plan_code": null,
    "pending_plan_title": null,
    "pending_change_effective_at": null
  }
}
This endpoint is useful for monitoring your credit balance programmatically — e.g., before running a batch job or in a CI pipeline. It returns both PAYG and subscription credit balances, plus full subscription details if you’re on a plan. No credits are deducted.

Authorizations

x-api-key
string
header
required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys

Response

Account info retrieved successfully

credits_balance
integer

PAYG (pay-as-you-go) credit balance — never expires

subscription_credits_balance
integer

Subscription wallet — current period's monthly allowance (0 if no subscription)

total_credits_balance
integer

Sum of PAYG + subscription credits

tier
enum<string>

Account tier (free, basic, pro, enterprise)

Available options:
free,
basic,
pro,
enterprise
rate_limit_per_minute
integer

Maximum API requests allowed per minute

subscription
object

Active subscription details, or null if PAYG-only