Skip to main content
GET
/
v1
/
user
/
balance
Get Balance
curl --request GET \
  --url https://api.lobstr.io/v1/user/balance \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "available": 123,
  "consumed": 123,
  "bonus_credit": 123,
  "rollover_credit": 123,
  "rollover_credit_expires_at": {},
  "interval": "<string>",
  "used_slots": 123,
  "total_available_slots": 123,
  "has_unpaid_bill": true,
  "reset_time": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

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

​
Response Field Explanations

​
id
string
The plan’s price identifier. Example: "price_abc123"
​
object
string
Always "plan".
​
name
string
Name of the active subscription plan. Example: "Professional"
​
available
integer
Total credits on the plan (including bonus). For daily-interval plans, this is the daily allowance. Example: 10000
​
consumed
integer
Credits consumed in the current billing period. Example: 1550
​
bonus_credit
integer
Bonus credits applied to the account. Example: 0
​
rollover_credit
integer
Unused credits rolled over from a previous period. Example: 200
​
rollover_credit_expires_at
string | null
Timestamp when rollover credits expire, or null if none. Example: null
​
interval
string
Credit reset interval ("monthly" or "daily"). Example: "monthly"
​
used_slots
integer
Number of concurrency slots currently in use. Example: 3
​
total_available_slots
integer
Total concurrency slots available on the plan. Example: 20
​
has_unpaid_bill
boolean
Whether there is an outstanding unpaid invoice. Example: false
​
reset_time
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

curl -X GET "https://api.lobstr.io/v1/user/balance" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Response

200
{
  "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": 20,
  "has_unpaid_bill": false,
  "reset_time": "2025-02-01T00:00:00Z"
}