Skip to main content
GET
/
v2
/
credits
Get Credit Balance
curl --request GET \
  --url https://api.example.com/v2/credits \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "credits": 4825
  },
  "metadata": {
    "action": "get_credits",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Retrieve the number of credits remaining on your account.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Response

​
success
boolean
Whether the request was successful
​
data
object
{
  "success": true,
  "data": {
    "credits": 4825
  },
  "metadata": {
    "action": "get_credits",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}

​
Notes

  • This endpoint does not consume any credits
  • Use this to monitor your usage and implement low-credit alerts in your application
  • Credits are consumed by most API actions — see the Introduction for details on the credit system