Version 1.0
Connector Overview: This page documents all 79 actions for the Xconnector v1.0.
Batch Compliance (3)
POST Create a batch compliance job
/2/compliance/jobs
Creates a new compliance job for Post IDs or user IDs.
A compliance job will contain an ID and a destination URL. The destination URL represents the location that contains the list of IDs consumed by your App
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The type of compliance job to create, such as "tweets" or "users". |
GET Get a compliance job by ID
/2/compliance/jobs/{id}
Get a single compliance job with the specified ID.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the compliance job to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get all batch compliance jobs
/2/compliance/jobs
Returns a list of recent compliance jobs.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The type of compliance jobs to retrieve, such as "tweets" or "users". |
|
|
The response format expected from the API (e.g. application/json). |
Blocks
GET Blocks lookup
/2/users/{id}/blocking
Returns a list of users who are blocked by the specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The user ID whose blocked users you would like to retrieve. The user’s ID must correspond to the user ID of the authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Bookmarks (3)
POST Bookmark a Post
/2/users/{id}/bookmarks
Allows an authenticated user to like a Post.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to like a Post. The ID must belong to the authenticating user. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the Post to bookmark. |
GET Bookmarked Posts
/2/users/{id}/bookmarks
Returns a list of Posts that have been bookmarked by a specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. User ID of the user to request liked Posts for. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove a Bookmark
/2/users/{id}/bookmarks/{tweet_id}
Allows an authenticated user to unlike a Post.
For full details, see the API reference for this endpoint.
Sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to unlike a Tweet. The ID must belong to the authenticating user. |
|
|
The ID of the Tweet to be unliked |
|
|
The response format expected from the API (e.g. application/json). |
Direct Messages Lookup (3)
GET DM events by 1-1 conversation
/2/dm_conversations/with/{participant_id}/dm_events
Returns DM Events for a DM Conversation by participant ID.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The User ID of who this one-to-one Direct Message is with. |
|
|
Allowed values: MessageCreate,ParticipantsJoin,ParticipantsLeave Comma-separated list of fields (with no spaces). All event types are returned by default. |
|
|
The maximum number of search results to be returned by a request. A number between 1 and the system limit (currently 100). By default, a request response will return 100 results. |
|
|
This parameter is used to get the next or previous 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Allowed values: duration_ms,height,media_key,non_public_metrics,organic_metrics,preview_image_url,promoted_metrics,public_metrics,type,url,width Default values: media_key,type Requires the attachments.media_keys expansion. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: attachments,author_id,context_annotations,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang,non_public_metrics,organic_metrics,possibly_sensitive,promoted_metrics,public_metrics,referenced_tweets,reply_settings,source,text,withheld Default fields: id, text, and edit_history_tweet_ids. Requires the referenced_tweets.id expansion. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld Default values: id,name,username Requires the participants_ids and/or sender_id expansions. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld Default values: id,name,username Requires the participants_ids and/or sender_id expansions. Comma-separated list of fields (with no spaces). |
|
|
The fields to include in the DM event objects, such as "id", "text", or "sender_id". |
|
|
The response format expected from the API (e.g. application/json). |
GET DM events by User
/2/dm_events
Returns all of the DM Events for an authenticated user.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Allowed values: id,text,event_type,dm_conversation_id,created_at,sender_id,attachments,participant_ids,referenced_tweets id, text, and event_type are returned by default. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: MessageCreate,ParticipantsJoin,ParticipantsLeave Comma-separated list of fields (with no spaces). All event types are returned by default. |
|
|
The maximum number of search results to be returned by a request. A number between 1 and the system limit (currently 100). By default, a request response will return 100 results. |
|
|
This parameter is used to get the next or previous 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Allowed values: duration_ms,height,media_key,non_public_metrics,organic_metrics,preview_image_url,promoted_metrics,public_metrics,type,url,width Default values: media_key,type Requires the attachments.media_keys expansion. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: attachments,author_id,context_annotations,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang,non_public_metrics,organic_metrics,possibly_sensitive,promoted_metrics,public_metrics,referenced_tweets,reply_settings,source,text,withheld Default fields: id, text, and edit_history_tweet_ids. Requires the referenced_tweets.id expansion. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld Default values: id,name,username Requires the participants_ids and/or sender_id expansions. Comma-separated list of fields (with no spaces). |
|
|
Allowed values: sender_id,referenced_tweets.id,attachments.media_keys,participant_ids
|
|
|
The response format expected from the API (e.g. application/json). |
GET Get DMs by conversation
/2/dm_conversations/{dm_conversation_id}/dm_events
Returns DM Events for a DM Conversation by conversation ID.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Events are retrieved for the conversation associated with this ID. Supports both one-to-one and group conversations. |
|
|
Allowed values: id,text,event_type,dm_conversation_id,created_at,sender_id,attachments,participant_ids,referenced_tweets
|
|
|
Allowed values: MessageCreate,ParticipantsJoin,ParticipantsLeave
|
|
|
The maximum number of search results to be returned by a request. A number between 1 and the system limit (currently 100). By default, a request response will return 100 results. |
|
|
This parameter is used to get the next or previous 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Allowed values: duration_ms,height,media_key,non_public_metrics,organic_metrics,preview_image_url,promoted_metrics,public_metrics,type,url,width
|
|
|
Allowed values: attachments,author_id,context_annotations,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang,non_public_metrics,organic_metrics,possibly_sensitive,promoted_metrics,public_metrics,referenced_tweets,reply_settings,source,text,withheld
|
|
|
Allowed values: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld
|
|
|
Allowed values: sender_id,referenced_tweets.id,attachments.media_keys,participant_ids
|
|
|
The response format expected from the API (e.g. application/json). |
Engagement Metrics (2)
GET Media Analytics
/2/media/analytics
Allows an authenticated user to find the analytics of a media.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The oldest UTC timestamp within last one year. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The oldest UTC timestamp within last one year within the 30 days time range. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
A comma separated list of MediaAnalytics fields to display. Available options: cta_url_clicks,cta_watch_clicks,media_key,play_from_tap,playback25,playback50,playback75,playback_complete,playback_start,timestamp,video_views,watch_time_ms |
|
|
Specifies the granularity. Available options:
|
|
|
A comma separated list of Media Keys. Up to 100 are allowed in a single request. The Media Key identifier for this attachment. |
|
|
The response format expected from the API (e.g. application/json). |
GET Post Analytics
/2/tweets/analytics
Allows an authenticated user to find the analytics of a post.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The Post ID for which you are requesting the analytics |
|
|
The oldest UTC timestamp within last one year. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The oldest UTC timestamp within last one year within the 30 days time range. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
Comma-separated list of fields for the analytics. Allowed values:
|
|
|
Specifies the granularity. Available options:
|
|
|
The response format expected from the API (e.g. application/json). |
Filtered Stream (3)
POST Delete Rules (by rule value)
/2/tweets/search/stream/rules
Delete filter rules. To delete one or more rules, submit a delete object payload with an array of rule values to delete.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve Rules
/2/tweets/search/stream/rules
Returns a list of filter rules currently active on the streaming endpoint.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Stream (see description)
/2/tweets/search/stream
Streams Posts in real-time based on a specific set of filter rules.
Please note streaming responses are currently not supported in Postman. Use this to help form your request, then click on Code > cURL. Copy the cURL command and paste in terminal to view the response.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Provide a whole number between 1 and 5. This parameter enables the recovery of up to five minutes worth of data that may have been missed during a disconnection. The backfilled Tweets will automatically flow through a reconnected stream, with older Tweets generally being delivered before any newly matching Tweets.
This feature is currently only available to the academic research product track. |
|
|
The response format expected from the API (e.g. application/json). |
Follows (4)
POST Follow a user ID
/2/users/{id}/following
Allows a user ID to follow another user.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to follow an account. The ID must belong to the authenticating user. In Postman, you can leave the id field empty to let the collection automatically populate it with the user ID of the user in the current environment. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the user to follow. |
GET Followers of user ID
/2/users/{id}/followers
Returns a list of users who are followers of the specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Unfollow a user ID
/2/users/{source_user_id}/following/{target_user_id}
Allows a user ID to unfollow another user.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to follow an account. The ID must belong to the authenticating user. In Postman, you can leave the source_user_id field empty to let the collection automatically populate it with the user ID of the user in the current environment. |
|
|
The ID of the user to unfollow. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the unfollow request, such as pagination or filtering parameters. |
GET Users a user ID is following
/2/users/{id}/following
Returns a list of users the specified user ID is following.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Hide Replies
PUT Unhide a reply
/2/tweets/{id}/hidden
Provides the ability to unhide a reply to a Post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single Tweet ID. |
|
|
The content type of the request body, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Set to "false" to unhide the reply. |
Likes (4)
POST Like a Post
/2/users/{id}/likes
Allows an authenticated user to like a Post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to like a Post. The ID must belong to the authenticating user. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the Post to like. |
GET Liked Posts
/2/users/{id}/liked_tweets
Returns a list of Posts that have been liked by a specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. User ID of the user to request liked Posts for. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Post object. Expansion required.
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
GET Liking users
/2/tweets/{id}/liking_users
Returns a list of users who have liked a specified Post ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The Post ID of the Post to request liking users of. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Post object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Unlike a Post
/2/users/{id}/likes/{tweet_id}
Allows an authenticated user to unlike a Post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to unlike a Post. The ID must belong to the authenticating user. |
|
|
The ID of the Post to be unliked |
|
|
The response format expected from the API (e.g. application/json). |
List/List Posts
GET List Posts lookup
/2/lists/{id}/tweets
This endpoint returns all Posts from a List specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to recieve Tweet details on. |
|
|
Comma-separated list of fields for the Tweet object.
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the User object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or tweet fields. |
List/List follows (4)
POST Follow a list
/2/users/{id}/followed_lists
Allows the authenticated user to follow a specified List.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the authenticated user |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the List to follow. |
GET Follower lookup
/2/lists/{id}/followers
This endpoint returns follower details from the List specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to recieve follower details on. |
|
|
Comma-separated list of fields for the User object.
|
|
|
Comma-separated list of fields for the Tweet object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or user fields. |
DELETE Unfollow a list
/2/users/{id}/followed_lists/{list_id}
Allows the authenticated user to unfollow a specified List.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the authenticated user |
|
|
Required. The ID of the List you wish to unfollow |
|
|
The response format expected from the API (e.g. application/json). |
GET User's followed Lists
/2/users/{id}/followed_lists
This endpoint returns details on Lists a user follows specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the user you wish to recieve details on which Lists they follow. |
|
|
Comma-separated fields for the List object.
|
|
|
Comma-separated list of fields for the User object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
List/List lookup (2)
GET List by ID
/2/lists/{id}
This endpoint returns details about the List specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to recieve details on. |
|
|
Comma-separated fields for the List object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the User object. Expansion required.
|
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as list fields. |
GET User owned Lists
/2/users/{id}/owned_lists
This endpoint returns details on user owned Lists specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the user you wish to recieve details on Lists they own. |
|
|
Comma-separated fields for the List object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the User object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
List/List members (4)
POST Add a member
/2/lists/{id}/members
Allows the authenticated user to add a member to a List they own.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the list you wish to add a member to - Authenticated user must own the list in order to add the member |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the user to add to the List. |
GET Members lookup
/2/lists/{id}/members
This endpoint returns member details from the List specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to recieve member details on. |
|
|
Comma-separated list of fields for the User object.
|
|
|
Comma-separated list of fields for the Tweet object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or user fields. |
DELETE Remove a member
/2/lists/{id}/members/{user_id}
Allows the authenticated user to remove a member from a List they own.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to remove a user from - the List must be owned by the authenticated user |
|
|
Required. The ID of the user you wish to remove from the list |
|
|
The response format expected from the API (e.g. application/json). |
GET User memberships
/2/users/{id}/list_memberships
This endpoint returns details on Lists a user is a member of specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the user you wish to recieve membership details on. |
|
|
Comma-separated fields for the List object.
|
|
|
Comma-separated list of fields for the User object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
List/Manage Lists (3)
POST Create a list
/2/lists
Allows the authenticated user to create a new List.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The name of the List to create. |
|
|
A description for the List. |
|
|
Whether the List should be private; set to "true" for private. |
DELETE Delete a list
/2/lists/{id}
Allows the authenticated user to delete a list they own.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the List you wish to delete - the List must be owned by the authenticated user |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update a list
/2/lists/{id}
Allows the authenticated user to update a List they own.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the List you wish to update the metadata of - the List must be owned by the authenticated user |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The new name for the List. |
|
|
The new description for the List. |
|
|
The new privacy setting; set to "true" for private. |
List/Pinned Lists (3)
POST Pin a list
/2/users/{id}/pinned_lists
Allows the authenticated user to pin a specified List.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the authenticated user |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the List to pin. |
DELETE Unpin a list
/2/lists/{id}/pinned_lists/{list_id}
Allows the authenticated user to unpin a specified List.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The ID of the authenticated user |
|
|
Required. The ID of the List you wish to unpin |
|
|
The response format expected from the API (e.g. application/json). |
GET User's pinned Lists
/2/users/{id}/pinned_lists
This endpoint returns details on a user's pinned Lists specified by the requested ID
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The user ID whose pinned Lists you would like to retrieve. The user’s ID must correspond to the user ID of the authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request. |
|
|
Comma-separated fields for the List object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the User object. Expansion required.
|
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
Manage Direct Messages (3)
POST Add DM to conversation
/2/dm_conversations/{dm_conversation_id}/messages
Creates a new message for a DM Conversation specified by DM Conversation ID.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The conversation ID that this message will be added to. Supports both one-to-one and group conversations. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The text content of the direct message. |
POST New 1-1 DM message
/2/dm_conversations/with/{participant_id}/messages
Creates a new message for a DM Conversation with a participant user by ID.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The User ID of who is receiving this one-to-one Direct Message |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The text content of the direct message. |
POST New group DM and conversation
/2/dm_conversations/
Creates a new DM Conversation.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of conversation, such as "group" or "personal". |
|
|
Provide a comma-separated list of user IDs to include as participants in the conversation. |
Manage Posts (2)
POST Create a Post
/2/tweets
Allows an authenticated user to create a Post.
You can add parameters to post polls, quote Posts, Post with reply settings, and Post to Super Followers in addition to other features.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The text content of the direct message. |
DELETE Delete a Post
/2/tweets/{id}
Allows an authenticated user to delete a Post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID to of the Tweet you wish to delete |
|
|
The response format expected from the API (e.g. application/json). |
Media/Metadata
POST Create Media Metadata
/2/media/metadata
Allows an authenticated user to add metadata to uploaded media.
You can use this endpoint to attach alt text to media. The media_id parameter specifies the media, while the alt_text contains the descriptive text.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the media item to which metadata will be added. |
Media/Subtitles (2)
POST Create Media Subtitles
/2/media/subtitles
Allows an authenticated user to add subtitles to uploaded media.
You can use this endpoint to provide subtitles for media. The media_id parameter identifies the media, while additional parameters define the subtitle language and file content.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the media item that will receive subtitles. |
|
|
The category of the media, such as "TWEET_VIDEO" or "DM_VIDEO", to specify the context. |
DELETE Delete Media Subtitles
/2/media/subtitles
Allows an authenticated user to delete subtitles from uploaded media.
You can use this endpoint to remove previously added subtitle information from media. The media_id parameter identifies the media, and specify other parameters to delete the subtitle.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the media item from which subtitles will be deleted. |
|
|
The category of the media to identify the correct subtitle track. |
Media/Upload (2)
GET Media Upload STATUS
/2/media/upload
Allows an authenticated user to check the processing status of uploaded media.
You can use this endpoint to monitor the status of video. The media_id parameter is from the the uploaded media, and the command=STATUS parameter retrieves information about whether the processing status is pending, in progress, or complete.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Media id for the requested media upload status. |
|
|
The command for the media upload request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Upload Media
/2/media/upload
Allows an authenticated user to upload media.
You can use this endpoint to upload videos before attaching them to Tweets. The media_type parameter specifies the type of media, while the command parameter controls the upload process by initializing, appending and finalizing the upload.
For full details, see the API reference for this endpoint.
To get started, sign up for the X API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the MIME type of the media being uploaded |
|
|
command : Specifies the current step in the media upload process.
|
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The media file content as a multipart form data or base64-encoded string. |
Mutes (3)
POST Mute a user ID
/2/users/{id}/muting
Allows a user ID to mute another user.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
GET Mutes lookup
/2/users/{id}/muting
Returns a list of users who are muted by the specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The user ID whose muted users you would like to retrieve. The user’s ID must correspond to the user ID of the authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the lookup, such as pagination or list fields. |
DELETE Unmute a user ID
/2/users/{source_user_id}/muting/{target_user_id}
Allows a user ID to unmute another user.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to unmute an account. The ID must belong to the authenticating user. In Postman, you can leave the source_user_id field empty to let the collection automatically populate it with the user ID of the user in the current environment. |
|
|
The ID of the user to unmute. |
|
|
The response format expected from the API (e.g. application/json). |
Post Counts (2)
GET Full-archive Post counts
/2/tweets/counts/all
Search across the complete history of public Posts matching a search query; since the first Post was created in March 2006.
For full details, see the API reference for this endpoint.
NOTE this endpoint requires access via the Academic Research product track
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The oldest UTC timestamp from which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The newest, most recent UTC timestamp to which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
Returns results with a Tweet ID less than (that is, older than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
This is the granularity that you want the timeseries count data to be grouped by. Possible values are day, hour or minute. The default granularity, if not specified is hour. |
|
|
The search query string to filter tweets, using standard Twitter search operators. |
|
|
The response format expected from the API (e.g. application/json). |
GET Recent Post counts
/2/tweets/counts/recent
Search for public Posts created in the last 7 days.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Query for matching Tweets. Up to 512 characters. |
|
|
The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The newest, most recent UTC timestamp to which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
Returns results with a Tweet ID less than (that is, older than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
This is the granularity that you want the timeseries count data to be grouped by. Possible values are day, hour or minute. The default granularity, if not specified is hour. |
|
|
The response format expected from the API (e.g. application/json). |
Post Lookup (2)
GET Multiple Posts
/2/tweets
This endpoint returns details about up to 100 Posts specified by the requested IDs.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter up to 100 comma-separated Tweet IDs. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Single Post Usercontext
/2/tweets/{id}
This endpoint returns details about the Post specified by the requested ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single Tweet ID. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
Quote Posts
GET Quote Posts by Post ID
/2/tweets/{id}/quote_tweets
Returns the most recent Tweets mentioning a single user specified by the requested user ID.
For full details, see the API reference for this endpoint.
Sign up for the Twitter API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. Retweets and replies are included in the count, even if exclude=retweets,replies are supplied. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
Returns results with an ID greater than (that is, more recent than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. |
|
|
Returns results with an ID less less than (that is, older than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available. |
|
|
This parameter is used to move forwards or backwards through pages of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
Reposts (3)
POST Repost a post
/2/users/{id}/retweets
Allows an authenticated user to Repost a post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to Repost a Post. The ID must belong to the authenticating user. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the Post to like. |
GET Reposted by
/2/tweets/{id}/retweeted_by
Returns a list of users who have liked a specified Post ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The Post ID of the Post to request Reposting users of. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The maximum number of results to be returned by a request.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Undo a Repost
/2/users/{id}/retweets/{source_tweet_id}
Allows an authenticated user to undo a Repost of a post.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the user who wishes to undo a Reweet. The ID must belong to the authenticating user. |
|
|
The ID of the Tweet to remove of Retweet of |
|
|
The response format expected from the API (e.g. application/json). |
Sampled Stream
GET Stream (see description)
/2/tweets/sample/stream
Stream, in real-time, roughly a 1% sample of all public Posts.
Please note streaming responses are currently not supported in Postman. Use this to help form your request, then click on Code > cURL. Copy the cURL command and paste in terminal to view the response.
For full details, see the API reference for these endpoints.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Provide a whole number between 1 and 5. This parameter enables the recovery of up to five minutes worth of data that may have been missed during a disconnection. The backfilled Tweets will automatically flow through a reconnected stream, with older Tweets generally being delivered before any newly matching Tweets.
This feature is currently only available to the academic research product track. |
|
|
The response format expected from the API (e.g. application/json). |
Search Posts (2)
GET Full-archive search
/2/tweets/search/all
Search across the complete history of public Posts matching a search query; since the first Post was created in March 2006.
For full details, see the API reference for this endpoint.
NOTE this endpoint requires access via the Academic Research product track
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Query for matching Tweets. Up to 1024 characters. |
|
|
The oldest UTC timestamp from which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The newest, most recent UTC timestamp to which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
Returns results with a Tweet ID less than (that is, older than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 100). By default, a request response will return 10 results. |
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Recent search
/2/tweets/search/recent
Search for public Posts created in the last 7 days.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Query for matching Tweets. Up to 512 characters. |
|
|
The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
The newest, most recent UTC timestamp to which the Tweets will be provided. YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). |
|
|
Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
Returns results with a Tweet ID less than (that is, older than) the specified ID. The ID specified is exclusive and responses will not include it. |
|
|
The maximum number of search results to be returned by a request. A number between 10 and the system limit (currently 100). By default, a request response will return 10 results. |
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
Spaces/Search Spaces
GET Search Spaces by title
/2/spaces/search
This endpoint returns Spaces matching the specified keyword query.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. A search term. Can be a keyword, hashtag, or mention. |
|
|
Return only Spaces with a specific running status. Allowed values (specify only one of the following):
|
|
|
Comma-separated list of fields from the Space object you want to return from your request. Available fields:
Default fields:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
Default values:
|
|
|
Comma-separated list of fields from the Space Topics object you want to return from your request
|
|
|
The response format expected from the API (e.g. application/json). |
Spaces/Spaces lookup (4)
GET Lookup Spaces created by one or more users
/2/spaces/by/creator_id
This endpoint returns information about a user. Specify user by username.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. A comma-separated list of user IDs. You can specify up 100 IDs in a single request. |
|
|
Comma-separated list of fields from the Space object you want to return from your request. Available fields:
Default fields:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
Default values:
|
|
|
Comma-separated list of fields from the Space Topics object you want to return from your request. Available values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Spaces lookup by list of IDs
/2/spaces
This endpoint returns information about one or more Spaces with the specified comma-separated list of IDs. You can request up to 100 Spaces in a single request
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. A comma separated list of IDs of the Spaces to lookup. You can specify up to 100 IDs. |
|
|
Comma-separated list of fields from the Space object you want to return from your request. Available fields:
Default fields:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
|
|
|
Comma-separated list of fields from the Space object you want to return from your request. Allowed values:
Default values:
|
|
|
Comma-separated list of fields from the Space Topics object you want to return from your request. Available values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Spaces lookup by single ID
/2/spaces/{id}
This endpoint returns information about a single Space with the specified ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the Spaces to lookup. |
|
|
Comma-separated list of fields from the Space object you want to return from your request. Available fields:
Default fields:
|
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Available values:
|
|
|
Comma-separated list of fields from the Space object you want to return from your request. Allowed values:
Default values:
|
|
|
Comma-separated list of fields from the Space Topics object you want to return from your request. Available values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Users who bought a ticket to a Space
/2/spaces/{id}/buyers
Returns a list of users who are blocked by the specified user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. The user ID whose blocked users you would like to retrieve. The user’s ID must correspond to the user ID of the authenticating user, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request. |
|
|
Comma-separated fields for the user object.
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object.
|
|
|
Comma-separated list of fields for the Tweet object. Expansion required.
|
|
|
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |
Timelines (3)
GET Reverse chronological home timeline by ID
/2/users/{id}/timelines/reverse_chronological
Allows you to retrieve a collection of the most recent Posts and Reposts posted by you or a user you follow. This endpoint can return every Post created on a timeline over the last 7 days and the most recent 800 regardless of the creation date.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the compliance job to retrieve. |
|
|
Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. Retweets and replies are included in the count, even if exclude=retweets,replies are supplied. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
Returns results with an ID greater than (that is, more recent than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. |
|
|
Returns results with an ID less less than (that is, older than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available. |
|
|
This parameter is used to move forwards or backwards through pages of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET User mention timeline by ID
/2/users/{id}/mentions
Allows you to retrieve a collection of the most recent Posts and Reposts posted by you or a user you follow. This endpoint returns up to the last 3200 Tweets.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. Retweets and replies are included in the count, even if exclude=retweets,replies are supplied. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
Returns results with an ID greater than (that is, more recent than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. |
|
|
Returns results with an ID less less than (that is, older than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available. |
|
|
This parameter is used to move forwards or backwards through pages of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
GET User post timeline by ID
/2/users/{id}/tweets
Returns the most recent Posts composed by a single user specified by the requested user ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Specifies the number of Tweets to try and retrieve, up to a maximum of 100 per distinct request. Retweets and replies are included in the count, even if exclude=retweets,replies are supplied. By default, 10 results are returned if this parameter is not supplied. The minimum permitted value is 5. |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
YYYY-MM-DDTHH:mm:ssZ (ISO 8601/RFC 3339). The oldest or earliest UTC timestamp from which the Tweets will be provided. Only the 3200 most recent Tweets are available. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). Minimum allowable time is 2010-11-06T00:00:00Z |
|
|
Returns results with an ID greater than (that is, more recent than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the since_id. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. |
|
|
Returns results with an ID less less than (that is, older than) the specified ID. Only the 3200 most recent Tweets are available. The result will exclude the until_id. If the limit of Tweets has occurred since the until_id, the until_id will be forced to the most recent ID available. |
|
|
This parameter is used to move forwards or backwards through pages of results, based on the value of the next_token or previous_token in the response. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. |
|
|
Comma-separated list of fields to expand. Expansions enable requests to expand an ID into a full object in the includes response object. Allowed values: attachments.poll_ids,attachments.media_keys,author_id,geo.place_id,in_reply_to_user_id,referenced_tweets.id,entities.mentions.username,referenced_tweets.id.author_id,edit_history_tweet_ids Default values: none |
|
|
Comma-separated list of fields for the Tweet object. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the user object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the media object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the place object. Expansion required. Allowed values:
Default values:
|
|
|
Comma-separated list of fields for the poll object. Expansion required. Allowed values:
Default values:
|
|
|
The response format expected from the API (e.g. application/json). |
Usage Posts
GET Get Posts Usage
/2/usage/tweets
Returns the Posts usage at a project and client app level
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma-separated list of fields for the usage object.
Default values:
|
|
|
Number of days for which you want the usage for |
|
|
The response format expected from the API (e.g. application/json). |
User Lookup (5)
GET Authenticated User Lookup
/2/me
This endpoint returns the information about an authorized user.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |
GET User by ID
/2/users/{id}
This endpoint returns details about a user by ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single user ID. |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |
GET User by Username
/2/users/by/username/{username}
This endpoint returns details about a user by username.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter a single Twitter username (handle). |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Users by ID
/2/users
This endpoint returns details about up to 100 users by ID.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter up to 100 comma-separated user IDs. |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |
GET Users by Username
/2/users/by
This endpoint returns details about up to 100 users specified by username.
For full details, see the API reference for this endpoint.
Sign up for the X API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Required. Enter up to 100 comma-separated usernames. |
|
|
Comma-separated fields for the user object. Allowed values:
Default values:
|
|
|
Expansions enable requests to expand an ID into a full object in the includes response object. Allowed value:
Default value: none |
|
|
Comma-separated list of fields for the Tweet object. Expansion required. Allowed values:
Default values:
OAuth1.0a User Context authorization required if any of the following fields are included in the request:
|
|
|
The response format expected from the API (e.g. application/json). |