X (Twitter) Tweets 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 Tweets. 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
38 operations
across 35 paths,
and defines 118 schemas.
It is described by OpenAPI 3.2.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
NextToken
string
The next token.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
NoteTweetText
string
The note content of the Tweet.
AddRulesRequest
object
A request to add a user-specified stream filtering rule.
1 property
1 required
Aggregate
integer
The sum of results returned in this response.
PlaceId
string
The identifier for this place.
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
Get2UsersIdTweetsResponse
object
4 properties
Get2Insights28hrResponse
object
2 properties
UsersRetweetsCreateRequest
object
1 property
1 required
Media
object
4 properties
1 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…
RulesResponseMetadata
object
4 properties
1 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
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
PaginationToken32
string
A base32 pagination token.
Place
object
8 properties
2 required
MediaWidth
integer
The width of the media in pixels.
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
TopicId
string
Unique identifier of this Topic.
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
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
Rule
object
A user-provided stream filtering rule.
3 properties
1 required
Error
object
2 properties
2 required
AppRulesCount
object
A count of user-provided stream filtering rules at the client application level.
2 properties
UsersRetweetsDeleteResponse
object
2 properties
RuleNoId
object
A user-provided stream filtering rule.
2 properties
1 required
TweetCreateResponse
object
2 properties
TimestampedMetrics
object
2 properties
RuleTag
string
A tag meant for the labeling of user provided rules.
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
End
string
The end time of the bucket.
PreviousToken
string
The previous token.
UsersLikesCreateResponse
object
2 properties
Get2TweetsIdResponse
object
3 properties
TweetText
string
The content of the Tweet.
Get2TweetsCountsAllResponse
object
3 properties
Get2TweetsIdRetweetedByResponse
object
4 properties
Start
string
The start time of the bucket.
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
AddOrDeleteRulesResponse
object
A response from modifying user-specified stream filtering rules.
3 properties
1 required
ResultCount
integer
The number of results returned in this response.
Expansions
object
6 properties
Tweet
object
29 properties
MediaKey
string
The Media Key identifier for this attachment.
StreamingTweetResponse
object
3 properties
Get2TweetsSearchStreamRulesCountsResponse
object
2 properties
RulesLookupResponse
object
2 properties
1 required
Get2TweetsCountsRecentResponse
object
3 properties
ListId
string
The unique identifier of this List.
PollOptionLabel
string
The text of a poll choice.
UsersRetweetsCreateResponse
object
2 properties
Get2TweetsSearchRecentResponse
object
4 properties
Url
string
A validly formatted URL.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
UrlImage
object
Represent the information for the URL image.
3 properties
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
Get2SpacesIdTweetsResponse
object
4 properties
Get2UsersIdTimelinesReverseChronologicalResponse
object
4 properties
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
FullTextEntities
object
5 properties
HttpStatusCode
integer
HTTP Status Code.
ClientAppId
string
The ID of the client application
Get2TweetsIdRetweetsResponse
object
4 properties
Metrics
object
19 properties
Analytics
object
2 properties
Get2ListsIdTweetsResponse
object
4 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
UserName
string
The X handle (screen name) of this user.
MediaHeight
integer
The height of the media in pixels.
NewestId
string
The newest id in this response.
TweetCreateRequest
object
16 properties
MediaId
string
The unique identifier of this Media.
PollId
string
Unique identifier of this poll.
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
OldestId
string
The oldest id in this response.
SearchCount
object
Represent a Search Count Result.
3 properties
3 required
RulesCount
object
A count of user-provided stream filtering rules at the application and project levels.
5 properties
Get2UsersIdMentionsResponse
object
4 properties
Get2TweetsResponse
object
3 properties
TweetHideRequest
object
1 property
1 required
DeleteRulesRequest
object
A response from deleting user-specified stream filtering rules.
1 property
1 required
Get2TweetsIdQuoteTweetsResponse
object
4 properties
UsersLikesDeleteResponse
object
2 properties
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
Engagement
object
An Engagement Api Response.
2 properties
UserIdMatchesAuthenticatedUser
string
Unique identifier of this User. The value must be the same as the authenticated user.
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
Get2TweetsSample10StreamResponse
object
3 properties
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
RuleId
string
Unique identifier of this rule.
TweetHideResponse
object
1 property
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.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
TweetCount
integer
The count for the bucket.
RuleValue
string
The filterlang value of the rule.
Get2SpacesIdBuyersResponse
object
4 properties
AllProjectClientApps
array
Client App Rule Counts for all applications in the project
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.
Get2TweetsSearchAllResponse
object
4 properties
UsersLikesCreateRequest
object
1 property
1 required
Geo
object
4 properties
3 required
TweetDeleteResponse
object
2 properties
CommunityId
string
The unique identifier of this Community.
Get2InsightsHistoricalResponse
object
2 properties
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
PaginationToken36
string
A base36 pagination token.
Get2UsersIdLikedTweetsResponse
object
4 properties
User
object
The X User object.
21 properties
3 required
Get2TweetsIdLikingUsersResponse
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X (Twitter) publishes across the network.
