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