Get User Credits
API Management
Get User Credits
Get your current credit balance and plan information
GET
Get User Credits
Check your current credit balance and plan information. This endpoint helps you monitor your available credits before creating jobs.
Response
Returns credit information including:number
Current balance of Pro credits (used when enrich=true)
number
Total Pro credits ever allocated
number
Current balance of Basic credits (used when enrich=false)
number
Total Basic credits ever allocated
number
Current balance of Private Key credits (used when
scraperKey is provided)number
Total Private Key credits ever allocated
string
Your current plan (e.g., “free”, “pro”)
Credits System
- Pro Credits: Used when creating jobs with
enrich=true - Basic Credits: Used when creating jobs with
enrich=false - Private Key Credits: Used when creating jobs with
scraperKey - Credit Deduction: Credits are deducted immediately when a job is created
- Credit Calculation: 1 credit per 100 results requested
Always check your credits before creating jobs to ensure you have sufficient balance.