Twitter/X Tweets 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 Tweets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
38 operations
across 35 paths,
and defines 119 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.
Metrics
object
19 properties
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
PlaceId
string
The identifier for this place.
Engagement
object
An Engagement Api Response.
2 properties
TweetCreateResponse
object
2 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
MediaId
string
The unique identifier of this Media.
StreamingTweetResponse
object
3 properties
PaginationToken32
string
A base32 pagination token.
RuleTag
string
A tag meant for the labeling of user provided rules.
End
string
The end time of the bucket.
Get2UsersIdMentionsResponse
object
4 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.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Get2TweetsSearchAllResponse
object
4 properties
UsersLikesCreateRequest
object
1 property
1 required
UsersRetweetsDeleteResponse
object
2 properties
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
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.
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
Start
string
The start time of the bucket.
UserIdMatchesAuthenticatedUser
string
Unique identifier of this User. The value must be the same as the authenticated user.
Error
object
2 properties
2 required
Get2TweetsIdLikingUsersResponse
object
4 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
Geo
object
4 properties
3 required
OldestId
string
The oldest id in this response.
TweetCreateRequest
object
16 properties
Aggregate
integer
The sum of results returned in this response.
RulesLookupResponse
object
2 properties
1 required
Get2TweetsSample10StreamResponse
object
3 properties
NextToken
string
The next token.
HttpStatusCode
integer
HTTP Status Code.
Get2UsersIdLikedTweetsResponse
object
4 properties
Get2SpacesIdBuyersResponse
object
4 properties
TweetDeleteResponse
object
2 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
Get2TweetsResponse
object
3 properties
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…
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
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
Get2TweetsCountsRecentResponse
object
3 properties
Get2ListsIdTweetsResponse
object
4 properties
TweetHideRequest
object
1 property
1 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
Analytics
object
2 properties
AppRulesCount
object
A count of user-provided stream filtering rules at the client application level.
2 properties
Media
object
4 properties
1 required
RuleId
string
Unique identifier of this rule.
PollId
string
Unique identifier of this poll.
ListId
string
The unique identifier of this List.
SearchCount
object
Represent a Search Count Result.
3 properties
3 required
ResultCount
integer
The number of results returned in this response.
TweetHideResponse
object
1 property
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
MediaWidth
integer
The width of the media in pixels.
CommunityId
string
The unique identifier of this Community.
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
Get2TweetsCountsAllResponse
object
3 properties
NewestId
string
The newest id in this response.
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.
MediaHeight
integer
The height of the media in pixels.
TweetCount
integer
The count for the bucket.
Get2TweetsIdResponse
object
3 properties
UsersLikesCreateResponse
object
2 properties
UserName
string
The X handle (screen name) of this user.
FullTextEntities
object
5 properties
TopicId
string
Unique identifier of this Topic.
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
Place
object
8 properties
2 required
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
Get2TweetsIdRetweetedByResponse
object
4 properties
PaginationToken36
string
A base36 pagination token.
Get2InsightsHistoricalResponse
object
2 properties
PreviousToken
string
The previous token.
Get2UsersIdTweetsResponse
object
4 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
Get2TweetsSearchRecentResponse
object
4 properties
Get2TweetsSearchStreamRulesCountsResponse
object
2 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Get2TweetsIdQuoteTweetsResponse
object
4 properties
Get2SpacesIdTweetsResponse
object
4 properties
AddOrDeleteRulesResponse
object
A response from modifying user-specified stream filtering rules.
3 properties
1 required
TimestampedMetrics
object
2 properties
UsersRetweetsCreateRequest
object
1 property
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
Get2UsersIdTimelinesReverseChronologicalResponse
object
4 properties
RulesCount
object
A count of user-provided stream filtering rules at the application and project levels.
5 properties
UsersLikesDeleteResponse
object
2 properties
Expansions
object
6 properties
UsersRetweetsCreateResponse
object
2 properties
Get2Insights28hrResponse
object
2 properties
Get2TweetsIdRetweetsResponse
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Twitter/X publishes across the network.
