Skip to main content
GET
/
v1
/
user
/
getCredits
Get User Credits
curl --request GET \
  --url https://discover.veritus.ai/api/v1/user/getCredits \
  --header 'Authorization: Bearer <token>'
{
  "proCreditsBalance": 123,
  "proCreditsTotal": 123,
  "basicCreditsBalance": 123,
  "basicCreditsTotal": 123,
  "privateKeyCreditsBalance": 123,
  "privateKeyCreditsTotal": 123,
  "plan": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.veritus.ai/llms.txt

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

Check your current credit balance and plan information. This endpoint helps you monitor your available credits before creating jobs.

​
Response

Returns credit information including:
​
proCreditsBalance
number
Current balance of Pro credits (used when enrich=true)
​
proCreditsTotal
number
Total Pro credits ever allocated
​
basicCreditsBalance
number
Current balance of Basic credits (used when enrich=false)
​
basicCreditsTotal
number
Total Basic credits ever allocated
​
privateKeyCreditsBalance
number
Current balance of Private Key credits (used when scraperKey is provided)
​
privateKeyCreditsTotal
number
Total Private Key credits ever allocated
​
plan
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.

​
Example Response

{
  "basicCreditsBalance": 4992,
  "basicCreditsTotal": 5000,
  "plan": "free",
  "proCreditsBalance": 1,
  "proCreditsTotal": 5,
  "privateKeyCreditsBalance": 9981,
  "privateKeyCreditsTotal": 10000
}