Get account - Xquik

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

200 OK
401 Unauthenticated
429 Rate Limited

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.

Show monitorBilling object

activeDailyEstimate

string

Estimated daily credits for currently active monitors.

activeHourlyBurn

string

Credits charged each hour for currently active monitors.

creditsPerActiveMonitorDay

string

Estimated daily credits for 1 active instant monitor.

creditsPerActiveMonitorHour

string

Hourly credits charged for 1 active instant monitor.

eventsIncluded

boolean

Whether webhook and event deliveries are included in monitor billing.

instantCheckIntervalSeconds

number

Active monitor check interval in seconds.

unlimitedSlots

boolean

Whether monitor slot count is unlimited.

creditInfo

object

Credit balance details. Omitted if no credit balance row exists yet.

Show creditInfo object

balance

string

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

lifetimePurchased

string

Total credits purchased across all time (Bigint string).

lifetimeUsed

string

Total credits consumed across all time (Bigint string).

autoTopupEnabled

boolean

Whether automatic credit top-up is enabled.

autoTopupAmountDollars

number

Dollar amount charged when automatic top-up runs.

autoTopupThreshold

string

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

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"
}

{ "error": "unauthenticated" }

Missing or invalid API key. Check the x-api-key header value.

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

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

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

Documentation Index

​Headers

​Response

​Credit balance

Headers

Response

Credit balance