Skip to main content
GET
Get Balance
This 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

string
required
Your API authentication token. Value: Token YOUR_API_KEY
string
default:"application/json"
Content type of the request. Value: application/json

Response Field Explanations

string
The plan’s price identifier. Example: "price_abc123"
string
Always "plan".
string
Name of the active subscription plan. Example: "Professional"
integer
Total credits on the plan (including bonus). For daily-interval plans, this is the daily allowance. Example: 10000
integer
Credits consumed in the current billing period. Example: 1550
integer
Bonus credits applied to the account. Example: 0
integer
Unused credits rolled over from a previous period. Example: 200
string | null
Timestamp when rollover credits expire, or null if none. Example: null
string
Credit reset interval ("monthly" or "daily"). Example: "monthly"
integer
Slots 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
integer
Slots 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
integer
Squids on your account, running or not. Example: 12
integer
Squids your plan holds: 100 per slot. Past it, creating a squid answers SquidsLimitExceeded. Example: 1000
object
Outstanding 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}
string
Timestamp 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

Response

200