Документация API

Справочник и руководство по использованию API

Account Status

GET

Описание

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.

URL эндпоинта

/api-proxy/myapi/status

Пример ответа

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.

Коды ошибок

Распространённые коды бизнес-ошибок от бэкенда. Все API используют единый формат: { code, msg, data }.

Примечание: `code` — код статуса в теле ответа и может отличаться от HTTP-статуса.

КодНазваниеОписаниеРекомендация
200УспехЗапрос успешно обработан.Используйте `data` для полезной нагрузки.
400Неверный запросНеверные параметры или ошибка валидации.Проверьте обязательные поля, диапазоны и формат запроса.
401Не авторизованОшибка аутентификации (требуется вход, отсутствует/неверный API-ключ).Войдите снова или укажите корректный X-API-Key.
402Недостаточно средствНедостаточно баланса или квоты для запроса.Пополните счёт или повысьте план и повторите.
403Доступ запрещёнНет прав или аккаунт ограничен.Проверьте статус аккаунта и права доступа.
404Не найденоЗапрашиваемый ресурс не существует.Проверьте ID/номера заказов и наличие данных.
429Превышен лимит запросовПревышена частота запросов (в секунду/час/месяц).Повторите с задержкой или снизьте частоту.
500Внутренняя ошибка сервераОшибка обработки на сервере.Повторите позже; при повторении обратитесь в поддержку.
502Сервис временно недоступенЗапрос к сервису не удалось обработать.Повторите позже.
503Сервис перегруженСистема перегружена или сработал глобальный лимит.Повторите через некоторое время.

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.

Генератор кода

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

Тест 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.