Get Balance
Check your account balance and available credits before launching operations
https://api.lobstr.io/v1/user/balanceThis endpoint returns your current account balance and credit information. Use it to check available credits before launching expensive scraping operations or to monitor your spending.
It's recommended to check your balance before starting large-scale data collection tasks to ensure you have sufficient credits.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderDefault application/jsonContent type of the request. Value: application/json
Response Field Explanations
idstringThe plan's price identifier. Example: "price_abc123"
objectstringAlways "plan".
namestringName of the active subscription plan. Example: "Professional"
availableintegerTotal credits on the plan (including bonus). For daily-interval plans, this is the daily allowance. Example: 10000
consumedintegerCredits consumed in the current billing period. Example: 1550
bonus_creditintegerBonus credits applied to the account. Example: 0
rollover_creditintegerUnused credits rolled over from a previous period. Example: 200
rollover_credit_expires_atstring | nullTimestamp when rollover credits expire, or null if none. Example: null
intervalstringCredit reset interval ("monthly" or "daily"). Example: "monthly"
used_slotsintegerSlots used by your runs in progress right now: the concurrency of each PENDING or RUNNING run of an active squid, added up. Squids that are not running use none. Example: 3
total_available_slotsintegerSlots on your plan: how many scrapers run at the same time across your squids. A launch that would go past them is refused with SlotsLimitExceeded. Example: 10
squidsintegerSquids on your account, running or not. Example: 12
max_squidsintegerSquids your plan holds: 100 per slot. Past it, creating a squid answers SquidsLimitExceeded. Example: 1000
has_unpaid_billobjectOutstanding unpaid invoice info. Empty object ({}) when there is no unpaid bill — despite the name, this is not a boolean. When a bill is outstanding it carries status (boolean) and created_on (Unix timestamp). Example: {"status": true, "created_on": 1777545119}
reset_timestringTimestamp when credits will next reset. Example: "2025-02-01T00:00:00Z"
Check your balance before launching expensive operations to avoid running out of credits mid-task. Large scraping jobs can consume significant credits.
Balance information is updated in real-time. Each successful API response reflects your current credit balance.
If your balance reaches zero, ongoing operations will be paused until you add more credits. Plan ahead to avoid service interruptions.
Code Examples
curl -X GET "https://api.lobstr.io/v1/user/balance" \ -H "Authorization: Token YOUR_API_KEY" \ -H "Content-Type: application/json"
Response
{ "id": "price_abc123", "object": "plan", "name": "Professional", "available": 10000, "consumed": 1550, "bonus_credit": 0, "rollover_credit": 200, "rollover_credit_expires_at": null, "interval": "monthly", "used_slots": 3, "total_available_slots": 10, "squids": 12, "max_squids": 1000, "has_unpaid_bill": {}, "reset_time": "2025-02-01T00:00:00Z" }