X (Twitter) Users 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 User. 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
45 operations
across 40 paths,
and defines 112 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.
UsersDMUnBlockCreateResponse
object
2 properties
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
MuteUserRequest
object
1 property
1 required
MuteUserMutationResponse
object
2 properties
NoteTweetText
string
The note content of the Tweet.
Get2UsersIdBlockingResponse
object
4 properties
Get2UsersSearchResponse
object
4 properties
PlaceId
string
The identifier for this place.
Get2UsersResponse
object
3 properties
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
UsersFollowingCreateRequest
object
1 property
1 required
Get2UsersIdTweetsResponse
object
4 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…
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.
Get2UsersIdFollowingResponse
object
4 properties
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
PaginationTokenLong
string
A 'long' pagination token.
Error
object
2 properties
2 required
ListUnpinResponse
object
2 properties
UsersRetweetsDeleteResponse
object
2 properties
ListPinnedResponse
object
2 properties
Get2UsersIdPinnedListsResponse
object
4 properties
ListFollowedResponse
object
2 properties
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
PreviousToken
string
The previous token.
PublicKey
object
Public key information for Chat encryption
4 properties
UsersLikesCreateResponse
object
2 properties
UsersFollowingDeleteResponse
object
2 properties
TweetText
string
The content of the Tweet.
Get2TweetsIdRetweetedByResponse
object
4 properties
Get2UsersIdAffiliatesResponse
object
4 properties
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
Get2UsersIdListMembershipsResponse
object
4 properties
Get2UsersIdFollowersResponse
object
4 properties
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.
ListId
string
The unique identifier of this List.
PollOptionLabel
string
The text of a poll choice.
UsersRetweetsCreateResponse
object
2 properties
Get2UsersIdBookmarksResponse
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
List
object
A X List is a curated group of accounts.
8 properties
2 required
Get2UsersByResponse
object
3 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.
Get2ListsIdMembersResponse
object
4 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
MediaHeight
integer
The height of the media in pixels.
UserName
string
The X handle (screen name) of this user.
NewestId
string
The newest id in this response.
BookmarkAddRequest
object
1 property
1 required
BookmarkFolderId
string
The unique identifier of this Bookmark folder.
Get2UsersByUsernameUsernameResponse
object
3 properties
BookmarkFolderPostsResponse
object
3 properties
BookmarkMutationResponse
object
2 properties
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.
Get2UsersIdMentionsResponse
object
4 properties
ListFollowedRequest
object
1 property
1 required
UsersDMBlockCreateResponse
object
2 properties
UsersLikesDeleteResponse
object
2 properties
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
Get2UsersIdOwnedListsResponse
object
4 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.
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
Get2UsersMeResponse
object
3 properties
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].
Get2UsersIdPublicKeysResponse
object
2 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.
Get2UsersRepostsOfMeResponse
object
4 properties
UsersLikesCreateRequest
object
1 property
1 required
Geo
object
4 properties
3 required
Get2UsersIdFollowedListsResponse
object
4 properties
Get2UsersIdMutingResponse
object
4 properties
ListPinnedRequest
object
1 property
1 required
CommunityId
string
The unique identifier of this Community.
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
Get2UsersPublicKeysResponse
object
2 properties
PaginationToken36
string
A base36 pagination token.
BookmarkFoldersResponse
object
3 properties
Get2UsersIdLikedTweetsResponse
object
4 properties
User
object
The X User object.
21 properties
3 required
Get2TweetsIdLikingUsersResponse
object
4 properties
UserSearchQueryVnext
string
The the search string by which to query for users.
Get2UsersIdResponse
object
3 properties
Get2ListsIdFollowersResponse
object
4 properties
UsersFollowingCreateResponse
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X (Twitter) publishes across the network.