Twitter/X Stream API is one of 22 APIs that Twitter/X publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Stream. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
22 operations
across 20 paths,
and defines 125 schemas.
It is described by OpenAPI 3.2.0, at version 2.166.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
LikeComplianceSchema
object
1 property
1 required
LikeWithTweetAuthor
object
A Like event, with the tweet author user and the tweet being liked
5 properties
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
TweetComplianceStreamResponse
Tweet compliance stream events.
UserDeleteComplianceSchema
object
1 property
1 required
PlaceId
string
The identifier for this place.
LikesComplianceStreamResponse
Likes compliance stream events.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
UserComplianceStreamResponse
User compliance stream events.
StreamingTweetResponse
object
3 properties
TweetNotice
object
7 properties
4 required
RuleTag
string
A tag meant for the labeling of user provided rules.
TweetLabelData
Tweet label data.
StreamingLikeResponseV2
object
3 properties
PostDeleteActivityResponsePayload
object
The identity of a deleted Post.
2 properties
2 required
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
TweetUndropComplianceSchema
object
1 property
1 required
UserComplianceData
User compliance data.
UserSuspendComplianceSchema
object
1 property
1 required
ActivityStreamingResponsePayload
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
Rule
object
A user-provided stream filtering rule.
3 properties
1 required
TweetLabelStreamResponse
Tweet label stream events.
UserUnprotectComplianceSchema
object
1 property
1 required
NewsActivityResponsePayload
object
4 properties
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
Url
string
A validly formatted URL.
MediaKey
string
The Media Key identifier for this attachment.
WebhookConfigId
string
The unique identifier of this webhook config.
UserUnsuspendComplianceSchema
object
1 property
1 required
UserUndeleteComplianceSchema
object
1 property
1 required
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
Tweet
object
32 properties
Error
object
2 properties
2 required
TweetComplianceData
Tweet compliance data.
ActivitySubscriptionCreateResponse
object
3 properties
ClientAppId
string
The ID of the client application
AddRulesRequest
object
A request to add a user-specified stream filtering rule.
1 property
1 required
Keyword
string
A keyword to filter on.
Geo
object
4 properties
3 required
RulesLookupResponse
object
2 properties
1 required
Get2TweetsSample10StreamResponse
object
3 properties
NextToken
string
The next token.
ActivitySubscriptionCreateRequest
object
4 properties
2 required
ActivityEventId
string
The unique identifier of an Activity event.
HttpStatusCode
integer
HTTP Status Code.
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
TweetTakedownComplianceSchema
object
4 properties
3 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
AppRulesCount
object
A count of user-provided stream filtering rules at the client application level.
2 properties
TweetDropComplianceSchema
object
1 property
1 required
Media
object
4 properties
1 required
TweetComplianceSchema
object
3 properties
2 required
RuleId
string
Unique identifier of this rule.
PollId
string
Unique identifier of this poll.
LikeId
string
The unique identifier of this Like.
WebhookLinksDeleteResponse
object
2 properties
ActivitySubscriptionId
string
The unique identifier of this subscription.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
MediaWidth
integer
The width of the media in pixels.
ActivitySubscription
object
An XActivity subscription.
7 properties
5 required
CommunityId
string
The unique identifier of this Community.
WebhookLinksCreateResponse
object
2 properties
AllProjectClientApps
array
Client App Rule Counts for all applications in the project
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
UrlImage
object
Represent the information for the URL image.
3 properties
PollOptionLabel
string
The text of a poll choice.
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
FollowActivityResponsePayload
object
2 properties
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties
1 required
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
TweetText
string
The content of the Tweet.
TweetNoticeSchema
object
1 property
1 required
MediaHeight
integer
The height of the media in pixels.
TweetWithheldComplianceSchema
object
1 property
1 required
TweetEditComplianceSchema
object
1 property
1 required
TweetUnviewable
object
3 properties
3 required
UserProfileModificationComplianceSchema
object
1 property
1 required
UserName
string
The X handle (screen name) of this user.
FullTextEntities
object
5 properties
TopicId
string
Unique identifier of this Topic.
UserTakedownComplianceSchema
object
3 properties
3 required
RulesResponseMetadata
object
4 properties
1 required
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
UserWithheldComplianceSchema
object
1 property
1 required
Place
object
8 properties
2 required
ActivityStreamingResponse
object
An activity event or error that can be returned by the x activity streaming API.
2 properties
DeleteRulesRequest
object
A response from deleting user-specified stream filtering rules.
1 property
1 required
NoteId
string
The unique identifier of this Community Note.
RuleNoId
object
A user-provided stream filtering rule.
2 properties
1 required
WebhookLinksGetResponse
object
2 properties
FilteredStreamingTweetResponse
object
A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that th…
4 properties
UserScrubGeoObjectSchema
object
3 properties
3 required
Get2TweetsSearchStreamRulesCountsResponse
object
2 properties
UnlikeComplianceSchema
object
2 properties
2 required
TweetEditComplianceObjectSchema
object
4 properties
4 required
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
TweetUnviewableSchema
object
1 property
1 required
TweetDeleteComplianceSchema
object
1 property
1 required
UserProfileModificationObjectSchema
object
4 properties
4 required
ActivitySubscriptionFilter
object
An XAA subscription filter.
3 properties
ProfileUpdateActivityResponsePayload
object
2 properties
AddOrDeleteRulesResponse
object
A response from modifying user-specified stream filtering rules.
3 properties
1 required
RuleValue
string
The filterlang value of the rule.
NoteTweetText
string
The note content of the Tweet.
User
object
The X User object.
21 properties
3 required
RulesCount
object
A count of user-provided stream filtering rules at the application and project levels.
5 properties
UserProtectComplianceSchema
object
1 property
1 required
Expansions
object
6 properties
UserComplianceSchema
object
2 properties
2 required
UserScrubGeoSchema
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Twitter/X publishes across the network.
