d5855df0e349

latestOpenAPI 3.1.02026-08-12128104480.9 KB
Events

List events

get/events

Query parameters

limitinteger

Maximum number of items to return (1-100, default 50). For paid per-result endpoints, the returned count may be lower when remaining credits cannot cover the requested page. If zero paid results are affordable, the endpoint returns 402 insufficient_credits.

cursorstring

Previous nextCursor.

monitorIdstring

Account monitor ID.

keywordMonitorIdstring

Keyword monitor ID.

eventType'tweet.new' | 'tweet.reply' | 'tweet.retweet' | 'tweet.quote' | 'tweet.media' | 'tweet.link' | 'tweet.poll' | 'tweet.mention' | 'tweet.hashtag' | 'tweet.longform' | 'profile.avatar.changed' | 'profile.banner.changed' | 'profile.name.changed' | 'profile.username.changed' | 'profile.bio.changed' | 'profile.location.changed' | 'profile.url.changed' | 'profile.verified.changed' | 'profile.protected.changed' | 'profile.pinned_tweet.changed' | 'profile.unavailable.changed'

Type of monitor event fired when account activity occurs.

Example:tweet.new

Filter events by type

Response

Event list

hasMoreboolean required
nextCursorstring

Example response

{
  "events": [],
  "nextCursor": "abc123"
}