Skip to main content
GET https://xquik.com/api/v1/credits

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 balance before starting a large tweet search, follower export, or reply export. Also read it before starting an 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.

Headers

Response

200 OK

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

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 }