Skip to main content
GET
/
account
Get account
curl --request GET \
  --url https://xquik.com/api/v1/account \
  --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/account \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

​
Headers

​
x-api-key
string
required
Your API key. Generate one from the API Keys page.

​
Response

​
plan
string
Subscription status. "active" or "inactive".
​
monitorsAllowed
number
Deprecated. Monitor slots are unlimited, so this is always 9007199254740991.
​
monitorsUsed
number
Number of currently active account monitors and keyword monitors.
​
monitorBilling
object
Active monitor billing details.
​
creditInfo
object
Credit balance details. Omitted if no credit balance row exists yet.
​
xUsername
string
Linked X username. Omitted when no X account is connected.
{
  "plan": "active",
  "monitorsAllowed": 9007199254740991,
  "monitorsUsed": 3,
  "monitorBilling": {
    "activeDailyEstimate": "1500",
    "activeHourlyBurn": "63",
    "creditsPerActiveMonitorDay": "500",
    "creditsPerActiveMonitorHour": "21",
    "eventsIncluded": true,
    "instantCheckIntervalSeconds": 1,
    "unlimitedSlots": true
  },
  "creditInfo": {
    "balance": "50000",
    "lifetimePurchased": "140000",
    "lifetimeUsed": "90000",
    "autoTopupEnabled": false,
    "autoTopupAmountDollars": 10,
    "autoTopupThreshold": "50000"
  },
  "xUsername": "elonmusk"
}

​
Credit balance

Every subscriber gets a monthly credit allowance. Metered reads bill per returned result or per call depending on the endpoint, writes bill per action, and active instant monitors bill 21 credits per hour while enabled. monitorsUsed, monitorBilling.activeHourlyBurn, and monitorBilling.activeDailyEstimate include active account monitors and active keyword monitors. Check creditInfo.balance to track remaining capacity. Use creditInfo.autoTopupEnabled, creditInfo.autoTopupAmountDollars, and creditInfo.autoTopupThreshold to inspect automatic top-up settings. At 0, metered API calls return 402 until you top up credits.
Related: Authentication · Billing & Usage
Last modified on May 8, 2026