Xquik credit balance, API usage & billing data

{
  "auto_topup_amount_dollars": 10,
  "auto_topup_enabled": false,
  "auto_topup_stopped": false,
  "auto_topup_threshold": "50000",
  "balance": "50000",
  "lifetime_purchased": "200000",
  "lifetime_used": "150000"
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

GET

credits

Xquik credit balance, API usage & billing data

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://xquik.com/api/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "auto_topup_amount_dollars": 123,
  "auto_topup_enabled": true,
  "auto_topup_stopped": true,
  "auto_topup_threshold": "<string>",
  "balance": "<string>",
  "lifetime_purchased": "<string>",
  "lifetime_used": "<string>"
}

When to read credits

This route is read-only. It returns current balance, lifetime totals, and automatic top-up settings. Use purchase and status routes only after deciding to add credits.

Check credits before tweets, followers, or monitors

Read the current balance before starting a large tweet search, follower export, reply export, active monitor, or X write. Compare the balance with the route’s documented credit cost. Reduce the requested result count when the available balance cannot cover the full job. Keep balance, lifetime_purchased, and lifetime_used as strings. These values can exceed JavaScript’s safe integer range. Convert them with a bigint library only when the client supports exact arithmetic. Review automatic top-up fields separately. auto_topup_enabled reports whether automatic funding is active. The threshold and dollar amount describe when and how much the account adds. auto_topup_stopped is true when declined charges stopped it. Ask the user to update the card in the dashboard to restart it. This endpoint never charges a payment method. Use standard top-up for a hosted checkout. Use quick top-up only after the account has a saved payment method. Poll standard checkout status with the checkout session ID.

Free. This endpoint does not consume credits.

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

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);

import requests

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

Headers

string

required

Your API key. Session cookie authentication is also supported.

Response

200 OK

number

Dollar amount charged when automatic top-up runs.

boolean

Whether automatic top-up is enabled.

boolean

Whether declined charges stopped automatic top-up while it is enabled. It stops after 3 declines in a row on one card. A paid top-up, a paid plan renewal, or the next automatic top-up on a new card clears it.

string

Credit balance threshold that triggers automatic top-up when enabled (Bigint string).

string

Current credit balance (Bigint string to preserve precision above Number.MAX_SAFE_INTEGER).

string

Total credits purchased (Bigint string).

string

Total credits consumed (Bigint string).

{
  "auto_topup_amount_dollars": 10,
  "auto_topup_enabled": false,
  "auto_topup_stopped": false,
  "auto_topup_threshold": "50000",
  "balance": "450",
  "lifetime_purchased": "1000",
  "lifetime_used": "550"
}

401 Unauthenticated

{ "error": "unauthenticated" }

Missing or invalid API key.

429 Rate limited

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 1
}

Too many requests. Wait for the Retry-After header before retrying.

Related. Top Up Credits · Get Top-Up Status · Quick Top-Up · Billing Guide

{
  "auto_topup_amount_dollars": 10,
  "auto_topup_enabled": false,
  "auto_topup_stopped": false,
  "auto_topup_threshold": "50000",
  "balance": "50000",
  "lifetime_purchased": "200000",
  "lifetime_used": "150000"
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

Xquik credit balance, API usage & billing data

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://xquik.com/api/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "auto_topup_amount_dollars": 123,
  "auto_topup_enabled": true,
  "auto_topup_stopped": true,
  "auto_topup_threshold": "<string>",
  "balance": "<string>",
  "lifetime_purchased": "<string>",
  "lifetime_used": "<string>"
}

Overview

X API

X write

Trends

Radar

Account

API keys

Guest wallets

Credits

X accounts

Monitors

Events

Webhooks

Draws

Extractions

Compose

Drafts

Styles

Support

Xquik credit balance, API usage & billing data

When to read credits

Check credits before tweets, followers, or monitors

Headers

Response

200 OK

401 Unauthenticated

429 Rate limited

​When to read credits

​Check credits before tweets, followers, or monitors

​Headers

​Response

​200 OK

​401 Unauthenticated

​429 Rate limited

When to read credits

Check credits before tweets, followers, or monitors

Headers

Response

200 OK

401 Unauthenticated

429 Rate limited