Skip to docs content
Browse and search
On this page

get_accounts

Read the accounts a product streams: the X watchlist with each account's settings (BASE), the Ultra Speed selection (ULTRA), or the Instagram watchlist (INSTAGRAM). Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:account scope.

POST/api/agent/actions/get_accounts

Authorization

  • AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key: Bearer <key>.

Body

  • familyenum<string>required

Response fields

  • accountsobject[]required
    • affiliateAlertsobjectrequired
      • availablebooleanrequired
      • enabledbooleanrequired
    • disabledEventTypesstring[]required
    • discordWebhookobjectrequiredPresent when a Discord webhook is saved; endsWith is the last 4 characters of its URL.
      • configuredenum<boolean>required
      • endsWithstringrequired
    • handlestringrequired
    • idstringrequired
    • keywordsstring[]required
    • namestringrequired
    • scopeenum<string>required
    • trialActivebooleanrequired
    • twitterUserIdstringrequired
  • familyenum<string>required

Responses

  • 200Success
  • 400The input does not match the action's schema (INVALID_REQUEST)
  • 401Missing or invalid API key
  • 403The request carried a foreign Origin
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later