Account

Get account info

Returns plan, credit, monitoring, and account settings for the authenticated user.

get/api/v1/account

Response

Account info

plan'active' | 'inactive' required

monitorsUsedinteger required

monitorsAllowedinteger required

Deprecated. Monitor slots are unlimited, so this is always Number.MAX_SAFE_INTEGER.

xUsernamestring

Linked X username, omitted when no X account is connected.

Example response

{
  "plan": "active",
  "monitorsUsed": 3,
  "monitorsAllowed": 9007199254740991,
  "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"
}

Changes

Changed in 4 of the 19 revisions of this API.731

Aug 24, 2026d6cb34aefa9f1See the full diff
- ●
  deleted the query request parameter cursor
  request-parameter-removed
Aug 21, 202618302a60cfee1See the full diff
- ○
  added the new optional query request parameter cursor
  new-optional-request-parameter
Aug 12, 20265d4938bb7de354See the full diff
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
Aug 12, 20264da209b29df818See the full diff
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added

Full history