> ## 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.

# Get credits

> Retrieve your credit balance, lifetime totals, and auto top-up settings

<blockquote className="agent-llms-directive">
  For the complete documentation index, see <a href="/llms.txt">llms.txt</a>.
</blockquote>

<Callout icon="circle-check" color="#16a34a">
  **Free** - does not consume credits
</Callout>

<CodeGroup>
  ```bash cURL theme={null}
  curl https://xquik.com/api/v1/credits \
    -H "x-api-key: xq_YOUR_KEY_HERE" | jq
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://xquik.com/api/v1/credits", {
    headers: { "x-api-key": "xq_YOUR_KEY_HERE" },
  });
  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://xquik.com/api/v1/credits",
      headers={"x-api-key": "xq_YOUR_KEY_HERE"},
  )
  data = response.json()
  print(data)
  ```
</CodeGroup>

## Headers

<ParamField header="x-api-key" type="string" required>
  Your API key. Session cookie authentication is also supported.
</ParamField>

## Response

<Tabs>
  <Tab title="200 OK">
    <ResponseField name="auto_topup_amount_dollars" type="number">Dollar amount charged when automatic top-up runs.</ResponseField>
    <ResponseField name="auto_topup_enabled" type="boolean">Whether automatic top-up is enabled.</ResponseField>
    <ResponseField name="auto_topup_threshold" type="string">Credit balance threshold that triggers automatic top-up when enabled (Bigint string).</ResponseField>
    <ResponseField name="balance" type="string">Current credit balance (Bigint string to preserve precision above Number.MAX\_SAFE\_INTEGER).</ResponseField>
    <ResponseField name="lifetime_purchased" type="string">Total credits purchased (Bigint string).</ResponseField>
    <ResponseField name="lifetime_used" type="string">Total credits consumed (Bigint string).</ResponseField>

    ```json theme={null}
    {
      "auto_topup_amount_dollars": 10,
      "auto_topup_enabled": false,
      "auto_topup_threshold": "50000",
      "balance": "450",
      "lifetime_purchased": "1000",
      "lifetime_used": "550"
    }
    ```
  </Tab>

  <Tab title="401 Unauthenticated">
    ```json theme={null}
    { "error": "unauthenticated" }
    ```

    Missing or invalid API key.
  </Tab>

  <Tab title="429 Rate Limited">
    ```json theme={null}
    { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 }
    ```

    Too many requests. Wait for the `Retry-After` header before retrying.
  </Tab>
</Tabs>

<Note>
  **Related:** [Top Up Credits](/api-reference/credits/topup) · [Get Top-Up Status](/api-reference/credits/topup-status) · [Quick Top-Up](/api-reference/credits/quick-topup) · [Billing Guide](/guides/billing)
</Note>