X (Twitter) Stream API
Endpoints related to streaming
X (Twitter) Stream API is one of 23 APIs that X (Twitter) 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, a getting-started guide, an API reference, authentication docs, and rate-limit docs.
This API exposes 22 operations across 20 paths, and defines 123 schemas. It is described by OpenAPI 3.0.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
22 operations
20 paths
123 schemas
1 DELETE18 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
X (Twitter) Stream API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes.
It uses HTTP oauth authentication (UserToken).
Paths & Operations 22
Across 20 paths, the API surfaces 22 operations — 1 DELETE, 18 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Stream 22
Endpoints related to streaming
GET
/2/activity/stream
X Activity Stream
POST
/2/activity/subscriptions
X Create X Activity Subscription
GET
/2/likes/compliance/stream
X Stream Likes Compliance Data
GET
/2/likes/firehose/stream
X Stream All Likes
GET
/2/likes/sample10/stream
X Stream Sampled Likes
GET
/2/tweets/compliance/stream
X Stream Posts Compliance Data
GET
/2/tweets/firehose/stream
X Stream All Posts
GET
/2/tweets/firehose/stream/lang/en
X Stream English Posts
GET
/2/tweets/firehose/stream/lang/ja
X Stream Japanese Posts
GET
/2/tweets/firehose/stream/lang/ko
X Stream Korean Posts
GET
/2/tweets/firehose/stream/lang/pt
X Stream Portuguese Posts
GET
/2/tweets/label/stream
X Stream Post Labels
GET
/2/tweets/sample/stream
X Stream Sampled Posts
GET
/2/tweets/sample10/stream
X Stream 10% Sampled Posts
GET
/2/tweets/search/stream
X Stream Filtered Posts
GET
/2/tweets/search/stream/rules
X Get Stream Rules
POST
/2/tweets/search/stream/rules
X Update Stream Rules
GET
/2/tweets/search/stream/rules/counts
X Get Stream Rule Counts
GET
/2/tweets/search/webhooks
X Get Stream Links
DELETE
/2/tweets/search/webhooks/{webhook_id}
X Delete Stream Link
POST
/2/tweets/search/webhooks/{webhook_id}
X Create Stream Link
GET
/2/users/compliance/stream
X Stream Users Compliance Data
Schemas 123
The contract defines 123 schemas that model the data the API accepts and returns. The most detailed are Tweet (29 properties), User (21 properties), UrlFields (9 properties), Place (8 properties). Each schema is shown below with its type and property counts.
TweetNotice
object
7 properties
4 required
AddOrDeleteRulesRequest
PollId
string
Unique identifier of this poll.
Media
object
4 properties
1 required
UserScrubGeoObjectSchema
object
3 properties
3 required
UserProtectComplianceSchema
object
1 property
1 required
AllProjectClientApps
array
Client App Rule Counts for all applications in the project
TweetWithheldComplianceSchema
object
1 property
1 required
Geo
object
4 properties
3 required
LikeWithTweetAuthor
object
A Like event, with the tweet author user and the tweet being liked
5 properties
TweetEditComplianceSchema
object
1 property
1 required
TweetComplianceSchema
object
3 properties
2 required
PlaceId
string
The identifier for this place.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
Get2TweetsSample10StreamResponse
object
3 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
HashtagEntity
TweetComplianceStreamResponse
Tweet compliance stream events.
UserUnsuspendComplianceSchema
object
1 property
1 required
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
Place
object
8 properties
2 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
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
StreamingTweetResponse
object
3 properties
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
UserWithheldComplianceSchema
object
1 property
1 required
TweetDeleteComplianceSchema
object
1 property
1 required
DeleteRulesRequest
object
A response from deleting user-specified stream filtering rules.
1 property
1 required
UserComplianceSchema
object
2 properties
2 required
CashtagEntity
ClientAppId
string
The ID of the client application
TweetDropComplianceSchema
object
1 property
1 required
TweetEditComplianceObjectSchema
object
4 properties
4 required
NoteTweetText
string
The note content of the Tweet.
RuleNoId
object
A user-provided stream filtering rule.
2 properties
1 required
UnlikeComplianceSchema
object
2 properties
2 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
WebhookConfigId
string
The unique identifier of this webhook config.
LikeComplianceSchema
object
1 property
1 required
ActivityStreamingResponse
object
An activity event or error that can be returned by the x activity streaming API.
2 properties
FollowActivityResponsePayload
object
2 properties
PollOptionLabel
string
The text of a poll choice.
PlaceType
string
TweetTakedownComplianceSchema
object
4 properties
3 required
CommunityId
string
The unique identifier of this Community.
TweetComplianceData
Tweet compliance data.
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…
UserComplianceStreamResponse
User compliance stream events.
User
object
The X User object.
21 properties
3 required
MentionEntity
FullTextEntities
object
5 properties
TweetUnviewable
object
3 properties
3 required
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
TweetNoticeSchema
object
1 property
1 required
Tweet
object
29 properties
TweetUndropComplianceSchema
object
1 property
1 required
RuleId
string
Unique identifier of this rule.
RulesCount
object
A count of user-provided stream filtering rules at the application and project levels.
5 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
RulesLookupResponse
object
2 properties
1 required
UserScrubGeoSchema
object
1 property
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
UserDeleteComplianceSchema
object
1 property
1 required
UserTakedownComplianceSchema
object
3 properties
3 required
Url
string
A validly formatted URL.
Expansions
object
6 properties
RuleValue
string
The filterlang value of the rule.
UserProfileModificationComplianceSchema
object
1 property
1 required
TweetText
string
The content of the Tweet.
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
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
UserSuspendComplianceSchema
object
1 property
1 required
HttpStatusCode
integer
HTTP Status Code.
ActivitySubscriptionFilter
object
An XAA subscription filter.
3 properties
RuleTag
string
A tag meant for the labeling of user provided rules.
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
TweetLabelData
Tweet label data.
ActivityStreamingResponsePayload
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.
MediaKey
string
The Media Key identifier for this attachment.
Error
object
2 properties
2 required
ActivitySubscriptionCreateRequest
object
4 properties
2 required
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
AppRulesCount
object
A count of user-provided stream filtering rules at the client application level.
2 properties
Keyword
string
A keyword to filter on.
WebhookLinksCreateResponse
object
2 properties
UserUndeleteComplianceSchema
object
1 property
1 required
ActivitySubscription
object
An XActivity subscription.
7 properties
5 required
AddOrDeleteRulesResponse
object
A response from modifying user-specified stream filtering rules.
3 properties
1 required
AddRulesRequest
object
A request to add a user-specified stream filtering rule.
1 property
1 required
MediaWidth
integer
The width of the media in pixels.
TweetLabelStreamResponse
Tweet label stream events.
WebhookLinksDeleteResponse
object
2 properties
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
ActivityEventId
string
The unique identifier of an Activity event.
UrlImage
object
Represent the information for the URL image.
3 properties
ActivitySubscriptionId
string
The unique identifier of this subscription.
LikesComplianceStreamResponse
Likes compliance stream events.
UserName
string
The X handle (screen name) of this user.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
TweetUnviewableSchema
object
1 property
1 required
NextToken
string
The next token.
Get2TweetsSearchStreamRulesCountsResponse
object
2 properties
UserUnprotectComplianceSchema
object
1 property
1 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
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
ProfileUpdateActivityResponsePayload
object
2 properties
Rule
object
A user-provided stream filtering rule.
3 properties
1 required
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
WebhookLinksGetResponse
object
2 properties
MediaHeight
integer
The height of the media in pixels.
TopicId
string
Unique identifier of this Topic.
RulesResponseMetadata
object
4 properties
1 required
RulesRequestSummary
ActivitySubscriptionCreateResponse
object
3 properties
UserComplianceData
User compliance data.
LikeId
string
The unique identifier of this Like.
NewsActivityResponsePayload
object
4 properties
UserProfileModificationObjectSchema
object
4 properties
4 required
StreamingLikeResponseV2
object
3 properties
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from X (Twitter) 12
Other APIs X (Twitter) publishes across the network.
X Ads API
X Activity API
X (Twitter) Account Activity API
X (Twitter) Activity API
X (Twitter) Bookmarks API
X (Twitter) Chat API
X (Twitter) Communities API
X (Twitter) Community Notes API
X (Twitter) Compliance API
X (Twitter) Connections API
X (Twitter) Direct Messages API
X (Twitter) General API
#Stream