Documentação da API

Referência detalhada da API e guia de uso

Account Status

GET

Description

Check your account service status, current credit balance, plan, monthly usage, and live rate-limit counters. Authenticate with X-API-Key or a Bearer token.

Endpoint URL

/api-proxy/myapi/status

Response Example

This excerpt highlights the key fields. Live responses may include additional raw Twitter/X fields.

{
  "code": 200,
  "msg": "success",
  "data": {
    "service": "ok",
    "account_status": "active",
    "credits": 2400.5,
    "plan": "Ultra",
    "plan_key": "ultra",
    "active_until": "2026-08-01T00:00:00+00:00",
    "rate_limit_per_second": 100,
    "rate_limit_per_hour": null,
    "rps_current": 2,
    "rph_current": 12,
    "monthly_limit": 50000,
    "month_calls": 1234,
    "monthly_remaining": 48766,
    "quota_period_start": "2026-07-01T00:00:00+00:00"
  }
}

返回字段

字段类型说明
codenumberBusiness status code. 200 means the request succeeded.
msgstringResponse message.
dataobjectResponse data object.
servicestringService availability flag inside the data object. ok means the API service is healthy.
account_statusstringAccount status inside the data object, for example active.
creditsnumberCurrent credit balance inside the data object.
planstringDisplay name of the current plan inside the data object.
plan_keystring | nullStable plan key inside the data object, for example ultra; may be null when no plan is active.
active_untilstring | nullPlan expiration time inside the data object in ISO 8601 format; null when not applicable.
rate_limit_per_secondnumber | nullAllowed requests per second inside the data object; null when not configured.
rate_limit_per_hournumber | nullAllowed requests per hour inside the data object; null when not configured.
rps_currentnumberRequests used in the current per-second window inside the data object.
rph_currentnumberRequests used in the current per-hour window inside the data object.
monthly_limitnumberMonthly request quota for the current plan inside the data object.
month_callsnumberRequests used in the current quota period inside the data object.
monthly_remainingnumber | nullRequests remaining in the current quota period inside the data object; null when there is no fixed monthly cap.
quota_period_startstringStart time of the current quota period inside the data object in ISO 8601 format.

Error Codes

Common business error codes returned by the backend. All APIs use the unified response format: { code, msg, data }.

Note: `code` is the business status code in response body and may differ from HTTP status.

CodeNameDescriptionRecommendation
200SuccessRequest processed successfully.Use `data` for business payload.
400Bad RequestInvalid parameters or business validation failed.Check required fields, value ranges, and request format.
401UnauthorizedAuthentication failed (login required, missing/invalid API key).Re-login or provide a valid `X-API-Key`.
402Insufficient BalanceInsufficient balance or call quota for this request.Recharge or upgrade your plan and retry.
403ForbiddenYou do not have permission or account status is restricted.Check account status and endpoint permission.
404Not FoundRequested resource does not exist.Verify IDs/order numbers and whether data exists.
429Rate Limit ExceededRequest frequency exceeded per-second/per-hour/monthly limits.Use retry with backoff or lower request frequency.
500Internal Server ErrorServer-side processing failed.Retry later and contact support if it persists.
502Service Temporarily UnavailableThe service request failed to be processed.Please try again later.
503Service BusySystem is busy or global protection limit is triggered.Retry after a short wait.

From docs to a live request

Check fields, quota, and limits before scaling search or monitoring jobs.

Account Status shows credits, plan, monthly usage, and live rate-limit counters. Response Fields help you see what n8n, Sheets, alerts, or AI workflows will receive before you wire the endpoint into production.

Code Generator

curl -X GET "https://www.twtapi.com/api-proxy/myapi/status?lang=pt" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Lang: pt"

Test API

If you do not have an API key yet, start by creating an account or opening the API dashboard to check your current plan, quota, and key-management entry points.