X Users API is one of 24 APIs that X 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 and API documentation.
This API exposes
44 operations
across 38 paths,
and defines 124 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://api.x.com, https://api.x.com/2.
The identity and technical contract details declared by the specification.
GetUsersLikedPostsResponse
object
4 properties
CreateUsersBookmarkResponseData
object
1 property
1 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
CreateUsersBookmarkFolderResponse
object
2 properties
FollowListRequest
object
1 property
1 required
PostMediaMetadata
array
Metadata for media attached to this Post.
BlockUsersDmsResponse
object
2 properties
UnmuteUserResponse
object
2 properties
GetUsersBookmarksResponse
object
4 properties
GetUsersFollowedListsResponse
object
4 properties
GetUsersByUsernameResponse
object
3 properties
GetUsersTimelineResponse
object
4 properties
UnblockUsersDmsResponse
object
2 properties
CreateUsersBookmarkFolderRequest
object
1 property
1 required
RepostPostRequest
object
1 property
1 required
GetUsersMeResponse
object
3 properties
ListMemberCount
integer
The number of members in this List.
FollowListResponseData
object
1 property
1 required
FollowListResponse
object
2 properties
DisallowedResourceProblem
object
7 properties
3 required
CreateUsersBookmarkRequest
object
2 properties
1 required
GetUsersMentionsResponse
object
4 properties
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
GetUsersListMembershipsResponse
object
4 properties
DeleteUsersBookmarkResponse
object
2 properties
UnfollowListResponseData
object
1 property
1 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
PostId
string
Unique identifier of a Post
UnmuteUserResponseData
object
1 property
1 required
UnfollowUserResponse
object
2 properties
NotAuthorizedForResourceProblem
object
9 properties
4 required
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
MuteUserRequest
object
1 property
1 required
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
UnlikePostResponseData
object
1 property
1 required
GetUsersPublicKeyResponse
object
2 properties
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
PinListRequest
object
1 property
1 required
CreateUsersBookmarkResponse
object
2 properties
GetUsersPublicKeysResponse
object
2 properties
UnblockUsersDmsResponseData
object
1 property
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.
GetUsersPostsResponse
object
4 properties
LikePostResponseData
object
1 property
1 required
UnfollowUserResponseData
object
1 property
1 required
PublicKeyId
string
Unique identifier of a PublicKey
FollowUserResponse
object
2 properties
Post
object
36 properties
ListId
string
Unique identifier of a List
UnfollowListResponse
object
2 properties
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
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.
RepostPostResponse
object
2 properties
ResourceUnavailableProblem
object
6 properties
4 required
Expansions
object
6 properties
ResourceNotFoundProblem
object
8 properties
4 required
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
MuteUserResponse
object
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
Place
object
8 properties
InvalidRequestProblem
object
6 properties
3 required
GetUsersPinnedListsResponse
object
4 properties
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property
1 required
GetUsersOwnedListsResponse
object
4 properties
GetUsersFollowingResponse
object
4 properties
GetUsersBookmarkFoldersResponseData
object
2 properties
2 required
ListFollowerCount
integer
The number of users who follow this List.
LikePostRequest
object
1 property
1 required
UnrepostPostResponse
object
2 properties
RepostPostResponseData
object
2 properties
2 required
SearchUsersResponse
object
4 properties
GetUsersBookmarkFoldersResponse
object
2 properties
DeleteUsersBookmarkResponseData
object
1 property
1 required
PinListResponseData
object
1 property
1 required
UnpinListResponseData
object
1 property
1 required
PostWithheld
object
Withholding details for withheld content.
3 properties
2 required
GetUsersFollowersResponse
object
4 properties
User
object
28 properties
UnrepostPostResponseData
object
1 property
1 required
GetUsersBookmarksByFolderIdResponse
object
2 properties
FollowUserResponseData
object
2 properties
2 required
PinListResponse
object
2 properties
UserWithheld
object
Withholding details for withheld content.
2 properties
UserSubscription
object
The subscription relationship between this User and you.
1 property
1 required
GetUsersAffiliatesResponse
object
4 properties
GetUsersRepostsOfMeResponse
object
4 properties
UserPublicMetrics
object
A list of metrics for this User.
6 properties
4 required
UserId
string
Unique identifier of a User
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.
GetUsersMutingResponse
object
4 properties
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
GetUsersByUsernamesResponse
object
3 properties
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
UnpinListResponse
object
2 properties
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
BlockUsersDmsResponseData
object
1 property
1 required
PublicKey
object
5 properties
FollowUserRequest
object
1 property
1 required
GetUsersByIdResponse
object
3 properties
MuteUserResponseData
object
1 property
1 required
GetUsersByIdsResponse
object
3 properties
CreateUsersBookmarkFolderResponseData
object
2 properties
2 required
PollOptions
array
The list of options (choices) available in this poll.
UnlikePostResponse
object
2 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.
LikePostResponse
object
2 properties
GetUsersBlockingResponse
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X publishes across the network.
