Skip to main content
GET
/
credits
Get credits
curl --request GET \
  --url https://xquik.com/api/v1/credits \
  --header 'x-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

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

Free - does not consume credits
curl https://xquik.com/api/v1/credits \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported.

​
Response

​
auto_topup_amount_dollars
number
Dollar amount charged when automatic top-up runs.
​
auto_topup_enabled
boolean
Whether automatic top-up is enabled.
​
auto_topup_threshold
string
Credit balance threshold that triggers automatic top-up when enabled (Bigint string).
​
balance
string
Current credit balance (Bigint string to preserve precision above Number.MAX_SAFE_INTEGER).
​
lifetime_purchased
string
Total credits purchased (Bigint string).
​
lifetime_used
string
Total credits consumed (Bigint string).
{
  "auto_topup_amount_dollars": 10,
  "auto_topup_enabled": false,
  "auto_topup_threshold": "50000",
  "balance": "450",
  "lifetime_purchased": "1000",
  "lifetime_used": "550"
}
Related: Top Up Credits · Get Top-Up Status · Quick Top-Up · Billing Guide
Last modified on May 5, 2026