Skip to main content
GET https://xquik.com/api/v1/account
Free. This endpoint does not consume credits.

Run an API account preflight

Call GET /account before a long tweet search, follower export, scheduled write, or monitor rollout. The response separates subscription access, available credits, and active monitor cost. It also separates automatic top-up settings and the linked X (Twitter) username.Use plan to report subscription state. Do not use it to decide whether credits remain. Funded pay-as-you-go requests can continue while plan is inactive. Treat missing creditInfo as no recorded balance, not numeric zero. Do not use monitorsAllowed as a capacity limit. The field is deprecated and always reports the maximum safe integer. Use monitorsUsed and the monitor billing fields for cost checks.

Store an account billing snapshot

Store a timestamped account snapshot before a worker starts billable work. Never convert credit strings to an unsafe JavaScript number.

Headers

Response

200 OK

401 Unauthenticated

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

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.

Credit balance

Every subscriber gets a monthly credit allowance. Metered reads bill per result or call. Writes bill per action. Active monitors bill 30 credits per hour. monitorsUsed, monitorBilling.activeHourlyBurn, and monitorBilling.activeDailyEstimate include active account monitors and active keyword monitors. The daily estimate is 24 hours of the hourly burn. At 0 credits, metered calls return 402.

Response examples

  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }