X Stream API is one of 23 APIs that 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 and API documentation.
This API exposes
18 operations
across 17 paths,
and defines 119 schemas.
It is described by OpenAPI 3.2.0, at version 2.168.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
StreamUsersComplianceResponse
User compliance stream events.
LikeWithPostAuthor
object
A Like event, with the tweet author user and the tweet being liked
5 properties
FieldHydrationFailureProblem
object
7 properties
4 required
StreamPostsComplianceResponse
Tweet compliance stream events.
ActivityEventId
string
The unique identifier of an Activity event.
StreamPostsFirehoseResponse
object
3 properties
ActivitySubscriptionFilter
object
An XAA subscription filter.
3 properties
Keyword
string
A keyword to filter on.
GetRuleCountsResponseData
object
5 properties
4 required
GetRulesResponse
object
3 properties
UserWithheld
object
Withholding details for withheld content.
2 properties
Error
object
2 properties
2 required
ResourceUnavailableProblem
object
6 properties
4 required
PostComplianceData
Tweet compliance data.
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
PostNotice
object
7 properties
4 required
PostMediaMetadata
array
Metadata for media attached to this Post.
UpdateRulesResponse
object
3 properties
GetRuleCountsResponseDataClientAppRulesCount
object
2 properties
1 required
InternalErrorProblem
object
4 properties
3 required
PostEditComplianceSchema
object
1 property
1 required
StreamPostsFirehosePtResponse
object
3 properties
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
UserAffiliation
object
Metadata about a user's affiliation.
4 properties
FollowActivityResponsePayload
object
2 properties
RuleId
string
Unique identifier of this rule.
UserSubscription
object
The subscription relationship between this User and you.
1 property
1 required
UserDeleteComplianceSchema
object
1 property
1 required
PostUndropComplianceSchema
object
1 property
1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
PostDropComplianceSchema
object
1 property
1 required
UserScrubGeoObjectSchema
object
3 properties
3 required
UserProfileModificationObjectSchema
object
4 properties
4 required
PostEditComplianceObjectSchema
object
4 properties
4 required
StreamPostsFirehoseEnResponse
object
3 properties
UserTakedownComplianceSchema
object
3 properties
3 required
PostReferencedPosts
array
A list of Posts this Post refers to. If the Post is a Retweet, Quote or Reply, it includes the referenced Post's type and ID.
PostComplianceSchema
object
3 properties
2 required
PostNotePost
object
The full content of the Post, including text beyond 280 characters.
2 properties
1 required
UserId
string
Unique identifier of a User
StreamPostsFirehoseJaResponse
object
3 properties
PostScopes
object
The scopes for this Post.
1 property
1 required
DisallowedResourceProblem
object
7 properties
3 required
ActivityStreamResponse
object
An activity event or error that can be returned by the x activity streaming API.
2 properties
PostSuggestedSourceLinksWithCounts
array
Suggested source URLs for this Post, each with the number of times it was suggested.
UpdateRulesResponseData
object
3 properties
UpdateRulesRequest
object
2 properties
PostNoticeSchema
object
1 property
1 required
Topic
object
3 properties
LikeId
string
The unique identifier of this Like.
UserProfileModificationComplianceSchema
object
1 property
1 required
PlaceContainedWithin
array
A list of unique identifiers of the Places that contain this place.
PostDeleteComplianceSchema
object
1 property
1 required
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property
1 required
UserSuspendComplianceSchema
object
1 property
1 required
StreamLabelsComplianceResponse
Tweet label stream events.
ActivityStreamingResponsePayload
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
StreamPostsResponse
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
StreamLikesComplianceResponse
Likes compliance stream events.
GetRulesResponseData
object
3 properties
UserUnsuspendComplianceSchema
object
1 property
1 required
PostGeo
object
The location tagged on the Post, if the user provided one.
2 properties
PostWithheldComplianceSchema
object
1 property
1 required
PostEntities
object
A list of metadata entities (hashtags, mentions, URLs) found in the Post text.
4 properties
MediaVariants
array
Each media object may have multiple display or playback variants, with different resolutions or formats.
NotAuthorizedForFieldProblem
object
10 properties
4 required
PostNoteRequestSuggestions
array
Community-Notes request suggestions for this Post.
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
PostUnviewable
object
3 properties
3 required
User
object
28 properties
UserScrubGeoSchema
object
1 property
1 required
RuleTag
string
A tag meant for the labeling of user provided rules.
UserPublicMetrics
object
A list of metrics for this User.
6 properties
4 required
StreamLikesSample10Response
object
3 properties
Place
object
8 properties
UnlikeComplianceSchema
object
2 properties
2 required
GetRuleCountsResponseDataAllProjectClientApps
object
2 properties
1 required
PostTakedownComplianceSchema
object
4 properties
3 required
PostLabelData
Tweet label data.
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties
6 required
Media
object
13 properties
UserUndeleteComplianceSchema
object
1 property
1 required
UserUnprotectComplianceSchema
object
1 property
1 required
StreamPostsSampleResponse
object
3 properties
PostId
string
Unique identifier of a Post
ProfileUpdateActivityResponsePayload
object
2 properties
StreamLikesFirehoseResponse
object
3 properties
UserWithheldComplianceSchema
object
1 property
1 required
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
NotAuthorizedForResourceProblem
object
9 properties
4 required
UpdateRulesDelete
object
2 properties
StreamPostsSample10Response
object
3 properties
PostUnviewableSchema
object
1 property
1 required
StreamPostsFirehoseKoResponse
object
3 properties
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
Post
object
36 properties
InvalidRequestProblem
object
6 properties
3 required
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
GetRuleCountsResponse
object
2 properties
LikeComplianceSchema
object
1 property
1 required
PollOptions
array
The list of options (choices) available in this poll.
PostDeleteActivityResponsePayload
object
The identity of a deleted Post.
2 properties
2 required
PlaceGeo
object
The geographic location of this place, expressed as a GeoJSON Feature.
3 properties
3 required
NewsActivityResponsePayload
object
4 properties
PostWithheld
object
Withholding details for withheld content.
3 properties
2 required
MediaOrganicMetrics
object
Organic nonpublic engagement metrics for the media at the time of the request.
6 properties
ResourceNotFoundProblem
object
8 properties
4 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
UserComplianceData
User compliance data.
UserComplianceSchema
object
2 properties
2 required
FieldUnauthorizedProblem
object
7 properties
4 required
UserProtectComplianceSchema
object
1 property
1 required
UpdateRulesAdd
object
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X publishes across the network.
