GET/v1/user/balance

Get Balance

Check your account balance and available credits before launching operations

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

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	No

Response Field Explanations

balance

number

Current account balance in credits

Example: 1250.75

total_credits_purchased

number

Total credits purchased since account creation

Example: 5000.00

credits_used

number

Credits consumed in the current billing period

Example: 3749.25

pending_cost

number

Estimated cost for currently running operations

Example: 50.00

expiration_date

stringnull

Credit expiration date (null if credits don't expire)

Example: 2024-12-31T23:59:59Z

Pro Tip

Check your balance before launching expensive operations to avoid running out of credits mid-task. Large scraping jobs can consume significant credits.

Note

Balance information is updated in real-time. Each successful API response reflects your current credit balance.

Warning

If your balance reaches zero, ongoing operations will be paused until you add more credits. Plan ahead to avoid service interruptions.