# X ## Docs - [Home](https://x-preview-add-redirects.mintlify.site/home.md) - [Platform overview](https://x-preview-add-redirects.mintlify.site/resources/platform-overview.md) - [Developer Apps](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/developer-apps.md) - [Projects](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/projects.md) - [Developer portal](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/developer-portal.md) - [Authentication](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/overview.md) - [Log in with X](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/guides/log-in-with-x.md) - [Best practices](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/guides/authentication-best-practices.md) - [Connection to X API using TLS](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/guides/tls.md) - [X API v2 authentication mapping](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/guides/v2-authentication-mapping.md) - [API Key and Secret](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/api-key-and-secret.md) - [Obtaining Access Tokens using 3-legged OAuth flow](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/obtaining-user-access-tokens.md) - [Authorizing a request](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/authorizing-a-request.md) - [OAuth Echo](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/oauth-echo.md) - [PIN-based authorization](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/pin-based-oauth.md) - [Creating a signature](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/creating-a-signature.md) - [Percent encoding parameters](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-1-0a/percent-encoding-parameters.md) - [OAuth 2.0](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-2-0/overview.md) - [App only authentication and OAuth 2.0 Bearer Token](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-2-0/application-only.md) - [Using and generating an app-only Bearer Token](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-2-0/bearer-tokens.md) - [OAuth 2.0 Authorization Code Flow with PKCE](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-2-0/authorization-code.md) - [How to connect to endpoints using OAuth 2.0 Authorization Code Flow with PKCE](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/oauth-2-0/user-access-token.md) - [Basic authentication](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/basic-auth.md) - [OAuth FAQ](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/faq.md) - [OAuth API reference index](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/authentication/api-reference.md) - [Counting characters when composing Tweets](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/counting-characters.md) - [Rate limits](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/rate-limits.md) - [X IDs](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/x-ids.md) - [Security](https://x-preview-add-redirects.mintlify.site/resources/fundamentals/security.md) - [X Official Partner](https://x-preview-add-redirects.mintlify.site/resources/enterprise/partner-directory.md) - [Enterprise data customers](https://x-preview-add-redirects.mintlify.site/resources/enterprise/customer-directory.md) - [Enterprise Access Form](https://x-preview-add-redirects.mintlify.site/resources/enterprise/forms/enterprise-api-interest.md) - [Government End User Request Form](https://x-preview-add-redirects.mintlify.site/resources/enterprise/forms/government-end-user-request.md) - [Tools and libraries](https://x-preview-add-redirects.mintlify.site/resources/tools-and-libraries.md) - [Tutorials](https://x-preview-add-redirects.mintlify.site/resources/tutorials.md): Instructions and examples to help you get started. - [API Reference Index](https://x-preview-add-redirects.mintlify.site/resources/api-reference-index.md) - [Subscribe to developer news](https://x-preview-add-redirects.mintlify.site/resources/newsletter.md) - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/introduction.md) - [About the X API](https://x-preview-add-redirects.mintlify.site/x-api/getting-started/about-x-api.md) - [How to get access to the X API](https://x-preview-add-redirects.mintlify.site/x-api/getting-started/getting-access.md) - [Make your first request to the X API](https://x-preview-add-redirects.mintlify.site/x-api/getting-started/make-your-first-request.md) - [Important resources](https://x-preview-add-redirects.mintlify.site/x-api/getting-started/important-resources.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/tools-and-libraries/overview.md) - [SDKs](https://x-preview-add-redirects.mintlify.site/x-api/tools-and-libraries/sdks.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/migrate/overview.md) - [Data Formation Migration](https://x-preview-add-redirects.mintlify.site/x-api/migrate/data-format-migration.md) - [X API endpoint map](https://x-preview-add-redirects.mintlify.site/x-api/migrate/x-api-endpoint-map.md) - [What to build](https://x-preview-add-redirects.mintlify.site/x-api/what-to-build.md) - [X API v2 data dictionary](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/data-dictionary.md) - [Fields](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/fields.md) - [Expansions](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/expansions.md) - [Post Annotations](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/post-annotations.md) - [Metrics](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/metrics.md) - [Conversation ID](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/conversation-id.md) - [Pagination](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/pagination.md) - [Versioning](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/versioning.md) - [Consistency](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/consistency.md) - [Rate limits](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/rate-limits.md) - [Post cap](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/post-cap.md) - [Edit Posts](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/edit-posts.md) - [Response codes and errors](https://x-preview-add-redirects.mintlify.site/x-api/fundamentals/response-codes-and-errors.md) - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/introduction.md) - [Recent Search](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/quickstart/recent-search.md) - [Full-archive Search](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/quickstart/full-archive-search.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/integrate/overview.md) - [Build a query](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/integrate/build-a-query.md) - [Pagination](https://x-preview-add-redirects.mintlify.site/x-api/posts/search/integrate/paginate.md) - [Full-archive search](https://x-preview-add-redirects.mintlify.site/x-api/posts/full-archive-search.md): Returns Posts that match a search query. - [Recent search](https://x-preview-add-redirects.mintlify.site/x-api/posts/recent-search.md): Returns Posts from the last 7 days that match a search query. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/counts/introduction.md) - [Search Posts (Recent)](https://x-preview-add-redirects.mintlify.site/x-api/posts/counts/quickstart/recent-tweet-counts.md) - [Search Posts (Full-archive)](https://x-preview-add-redirects.mintlify.site/x-api/posts/counts/quickstart/full-archive-tweet-counts.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/posts/counts/integrate/overview.md) - [Build a query](https://x-preview-add-redirects.mintlify.site/x-api/posts/counts/integrate/build-a-query.md) - [Full archive search counts](https://x-preview-add-redirects.mintlify.site/x-api/posts/full-archive-search-counts.md): Returns Post Counts that match a search query. - [Recent search counts](https://x-preview-add-redirects.mintlify.site/x-api/posts/recent-search-counts.md): Returns Post Counts from the last 7 days that match a search query. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/quickstart.md) - [Build a rule](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/build-a-rule.md) - [Consuming streaming data](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/consuming-streaming-data.md) - [Handling disconnections](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/handling-disconnections.md) - [Handling high-volume capacity](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/handling-high-volume-capacity.md) - [Matching Posts to Rules](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/matching-returned-tweets.md) - [Recovery and redundancy](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream/integrate/recovery-and-redundancy-features.md) - [Filtered stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/filtered-stream.md): Streams Posts matching the stream's active rule set. - [Rules lookup](https://x-preview-add-redirects.mintlify.site/x-api/posts/rules-lookup.md): Returns rules from a User's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids. - [Rules Count](https://x-preview-add-redirects.mintlify.site/x-api/posts/rules-count.md): Returns the counts of rules from a User's active rule set, to reflect usage by project and application. - [Add/Delete rules](https://x-preview-add-redirects.mintlify.site/x-api/posts/adddelete-rules.md): Add or delete rules from a User's active rule set. Users can provide unique, optionally tagged rules to add. Users can delete their entire rule set or a subset specified by rule ids or values. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/timelines/introduction.md): The X API v2 has three timelines endpoints - reverse chronological home timeline, user Post timeline, and user mention timeline. See below for more details. - [Reverse Chronological](https://x-preview-add-redirects.mintlify.site/x-api/posts/timelines/quickstart/reverse-chron-quickstart.md) - [User Mentions](https://x-preview-add-redirects.mintlify.site/x-api/posts/timelines/quickstart/user-mention-quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/posts/timelines/integrate.md) - [User Posts timeline by User ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/user-posts-timeline-by-user-id.md): Returns a list of Posts authored by the provided User ID - [User mention timeline by User ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/user-mention-timeline-by-user-id.md): Returns Post objects that mention username associated to the provided User ID - [User home timeline by User ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/user-home-timeline-by-user-id.md): Returns Post objects that appears in the provided User ID's home timeline - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/lookup/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/posts/lookup/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/posts/lookup/integrate.md) - [Post lookup by Post IDs](https://x-preview-add-redirects.mintlify.site/x-api/posts/post-lookup-by-post-ids.md): Returns a variety of information about the Post specified by the requested ID. - [Post lookup by Post ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/post-lookup-by-post-id.md): Returns a variety of information about the Post specified by the requested ID. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/bookmarks/introduction.md) - [Bookmarks lookup](https://x-preview-add-redirects.mintlify.site/x-api/posts/bookmarks/quickstart/bookmarks-lookup.md) - [Manage bookmarks](https://x-preview-add-redirects.mintlify.site/x-api/posts/bookmarks/quickstart/manage-bookmarks.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/posts/bookmarks/integrate.md) - [Bookmark folders by User](https://x-preview-add-redirects.mintlify.site/x-api/bookmarks/bookmark-folders-by-user.md): Returns metadata about Bookmark folders that have been created by the requesting User - [Bookmark Folder Posts by User and Folder id](https://x-preview-add-redirects.mintlify.site/x-api/bookmarks/bookmark-folder-posts-by-user-and-folder-id.md): Returns posts belonging to input bookmarks folder id that have been created by the requesting User - [Bookmarks by User](https://x-preview-add-redirects.mintlify.site/x-api/bookmarks/bookmarks-by-user.md): Returns Post objects that have been bookmarked by the requesting User - [Add Post to Bookmarks](https://x-preview-add-redirects.mintlify.site/x-api/bookmarks/add-post-to-bookmarks.md): Adds a Post (ID in the body) to the requesting User's (in the path) bookmarks - [Remove a bookmarked Post](https://x-preview-add-redirects.mintlify.site/x-api/bookmarks/remove-a-bookmarked-post.md): Removes a Post from the requesting User's bookmarked Posts. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/manage-tweets/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/posts/manage-tweets/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/posts/manage-tweets/integrate.md) - [Creation of a Post](https://x-preview-add-redirects.mintlify.site/x-api/posts/creation-of-a-post.md): Causes the User to create a Post under the authorized account. - [Post delete by Post ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/post-delete-by-post-id.md): Delete specified Post (in the path) by ID. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/retweets/introduction.md) - [Retweets lookup](https://x-preview-add-redirects.mintlify.site/x-api/posts/retweets/quickstart/retweets-lookup.md) - [Manage Retweets](https://x-preview-add-redirects.mintlify.site/x-api/posts/retweets/quickstart/manage-retweets.md) - [Retweets of Me](https://x-preview-add-redirects.mintlify.site/x-api/posts/retweets/quickstart/retweets-of-me.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/posts/retweets/integrate.md) - [Returns User objects that have retweeted the provided Post ID](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-have-retweeted-the-provided-post-id.md): Returns a list of Users that have retweeted the provided Post ID - [Causes the User (in the path) to repost the specified Post.](https://x-preview-add-redirects.mintlify.site/x-api/posts/causes-the-user-in-the-path-to-repost-the-specified-post.md): Causes the User (in the path) to repost the specified Post. The User in the path must match the User context authorizing the request. - [Causes the User (in the path) to unretweet the specified Post](https://x-preview-add-redirects.mintlify.site/x-api/posts/causes-the-user-in-the-path-to-unretweet-the-specified-post.md): Causes the User (in the path) to unretweet the specified Post. The User must match the User context authorizing the request - [Retrieve Posts that repost a Post.](https://x-preview-add-redirects.mintlify.site/x-api/posts/retrieve-posts-that-repost-a-post.md): Returns a variety of information about each Post that has retweeted the Post specified by the requested ID. - [Returns repost of user](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-repost-of-user.md): This endpoint returns reposts of the requesting User. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/quote-tweets/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/posts/quote-tweets/quickstart.md) - [Retrieve Posts that quote a Post.](https://x-preview-add-redirects.mintlify.site/x-api/posts/retrieve-posts-that-quote-a-post.md): Returns a variety of information about each Post that quotes the Post specified by the requested ID. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies/introduction.md) - [Apps](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies/apps.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies/quickstart.md) - [Manage replies by topic](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies/integrate/manage-replies-by-topic.md) - [Manage replies by topic](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies/integrate/manage-replies-in-realtime.md) - [Hide replies](https://x-preview-add-redirects.mintlify.site/x-api/posts/hide-replies.md): Hides or unhides a reply to an owned conversation. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/users/lookup/introduction.md) - [User lookup](https://x-preview-add-redirects.mintlify.site/x-api/users/lookup/quickstart/user-lookup.md) - [Authenticated user lookup](https://x-preview-add-redirects.mintlify.site/x-api/users/lookup/quickstart/authenticated-lookup.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/users/lookup/integrate.md) - [User lookup by ID](https://x-preview-add-redirects.mintlify.site/x-api/users/user-lookup-by-id.md): This endpoint returns information about a User. Specify User by ID. - [User lookup by IDs](https://x-preview-add-redirects.mintlify.site/x-api/users/user-lookup-by-ids.md): This endpoint returns information about Users. Specify Users by their ID. - [User lookup by usernames](https://x-preview-add-redirects.mintlify.site/x-api/users/user-lookup-by-usernames.md): This endpoint returns information about Users. Specify Users by their username. - [User lookup by username](https://x-preview-add-redirects.mintlify.site/x-api/users/user-lookup-by-username.md): This endpoint returns information about a User. Specify User by username. - [User lookup me](https://x-preview-add-redirects.mintlify.site/x-api/users/user-lookup-me.md): This endpoint returns information about the requesting User. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/users/search/introduction.md) - [User search](https://x-preview-add-redirects.mintlify.site/x-api/users/user-search.md): Returns Users that match a search query. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/users/follows/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/users/follows/quickstart.md) - [Followers by User ID](https://x-preview-add-redirects.mintlify.site/x-api/users/followers-by-user-id.md): Returns a list of Users who are followers of the specified User ID. - [Following by User ID](https://x-preview-add-redirects.mintlify.site/x-api/users/following-by-user-id.md): Returns a list of Users that are being followed by the provided User ID - [Follow User](https://x-preview-add-redirects.mintlify.site/x-api/users/follow-user.md): Causes the User(in the path) to follow, or “request to follow” for protected Users, the target User. The User(in the path) must match the User context authorizing the request - [Unfollow User](https://x-preview-add-redirects.mintlify.site/x-api/users/unfollow-user.md): Causes the source User to unfollow the target User. The source User must match the User context authorizing the request - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/users/mutes/introduction.md) - [Manage mutes](https://x-preview-add-redirects.mintlify.site/x-api/users/mutes/quickstart/manage-mutes-quickstart.md) - [Mutes lookup](https://x-preview-add-redirects.mintlify.site/x-api/users/mutes/quickstart/mutes-lookup.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/users/mutes/integrate.md) - [Mute User by User ID.](https://x-preview-add-redirects.mintlify.site/x-api/users/mute-user-by-user-id.md): Causes the User (in the path) to mute the target User. The User (in the path) must match the User context authorizing the request. - [Unmute User by User ID](https://x-preview-add-redirects.mintlify.site/x-api/users/unmute-user-by-user-id.md): Causes the source User to unmute the target User. The source User must match the User context authorizing the request - [Returns User objects that are muted by the provided User ID](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-are-muted-by-the-provided-user-id.md): Returns a list of Users that are muted by the provided User ID - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/users/blocks/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/users/blocks/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/users/blocks/integrate.md) - [Returns User objects that are blocked by provided User ID](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-are-blocked-by-provided-user-id.md): Returns a list of Users that are blocked by the provided User ID - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/manage/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/manage/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/manage/integrate.md) - [Create a new DM Conversation](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/create-a-new-dm-conversation.md): Creates a new DM Conversation. - [Delete Dm](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/delete-dm.md): Delete a Dm Event that you own. - [Send a new message to a user](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/send-a-new-message-to-a-user.md): Creates a new message for a DM Conversation with a participant user by ID - [Send a new message to a DM Conversation](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/send-a-new-message-to-a-dm-conversation.md): Creates a new message for a DM Conversation specified by DM Conversation ID - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/lookup/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/lookup/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/lookup/integrate.md) - [Get DM Events for a DM Conversation](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/get-dm-events-for-a-dm-conversation.md): Returns DM Events for a DM Conversation - [Get DM Events for a DM Conversation](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/get-dm-events-for-a-dm-conversation-1.md): Returns DM Events for a DM Conversation - [Get recent DM Events](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/get-recent-dm-events.md): Returns recent DM Events across DM conversations - [Get DM Events by id](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/get-dm-events-by-id.md): Returns DM Events by event id. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/direct-messages/blocks/introduction.md) - [Causes DMs to/from the target User (in the path) to be blocked by the authenticated request user](https://x-preview-add-redirects.mintlify.site/x-api/users/causes-dms-tofrom-the-target-user-in-the-path-to-be-blocked-by-the-authenticated-request-user.md): Causes DMs to/from the target User (in the path) to be blocked by the authenticated request user - [Causes DMs to/from the target User (in the path) to be unblocked by the authenticated request user](https://x-preview-add-redirects.mintlify.site/x-api/users/causes-dms-tofrom-the-target-user-in-the-path-to-be-unblocked-by-the-authenticated-request-user.md): Causes DMs to/from the target User (in the path) to be unblocked by the authenticated request user - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/likes/introduction.md) - [Likes lookup](https://x-preview-add-redirects.mintlify.site/x-api/posts/likes/quickstart/likes-lookup.md) - [Manage Likes](https://x-preview-add-redirects.mintlify.site/x-api/posts/likes/quickstart/manage-likes.md) - [Returns Post objects liked by the provided User ID](https://x-preview-add-redirects.mintlify.site/x-api/posts/returns-post-objects-liked-by-the-provided-user-id.md): Returns a list of Posts liked by the provided User ID - [Returns User objects that have liked the provided Post ID](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-have-liked-the-provided-post-id.md): Returns a list of Users that have liked the provided Post ID - [Causes the User (in the path) to like the specified Post](https://x-preview-add-redirects.mintlify.site/x-api/posts/causes-the-user-in-the-path-to-like-the-specified-post.md): Causes the User (in the path) to like the specified Post. The User in the path must match the User context authorizing the request. - [Causes the User (in the path) to unlike the specified Post](https://x-preview-add-redirects.mintlify.site/x-api/posts/causes-the-user-in-the-path-to-unlike-the-specified-post.md): Causes the User (in the path) to unlike the specified Post. The User must match the User context authorizing the request - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-lookup/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-lookup/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-lookup/integrate.md) - [List lookup by List ID.](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-lookup-by-list-id.md): Returns a List. - [Get User's Followed Lists](https://x-preview-add-redirects.mintlify.site/x-api/lists/get-users-followed-lists.md): Returns a User's followed Lists. - [Get a User's Owned Lists.](https://x-preview-add-redirects.mintlify.site/x-api/lists/get-a-users-owned-lists.md): Get a User's Owned Lists. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-tweets/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-tweets/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-tweets/integrate.md) - [List Posts timeline by List ID.](https://x-preview-add-redirects.mintlify.site/x-api/posts/list-posts-timeline-by-list-id.md): Returns a list of Posts associated with the provided List ID. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/lists/manage-lists/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/lists/manage-lists/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/lists/manage-lists/integrate.md) - [Create List](https://x-preview-add-redirects.mintlify.site/x-api/lists/create-list.md): Creates a new List. - [Update List.](https://x-preview-add-redirects.mintlify.site/x-api/lists/update-list.md): Update a List that you own. - [Delete List](https://x-preview-add-redirects.mintlify.site/x-api/lists/delete-list.md): Delete a List that you own. - [Follow a List](https://x-preview-add-redirects.mintlify.site/x-api/lists/follow-a-list.md): Causes a User to follow a List. - [Unfollow a List](https://x-preview-add-redirects.mintlify.site/x-api/lists/unfollow-a-list.md): Causes a User to unfollow a List. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-members/introduction.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-members/quickstart/overview.md) - [List members lookup](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-members/quickstart/list-members-lookup.md) - [Manage list members](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-members/quickstart/manage-list-members.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/lists/list-members/integrate.md) - [Add a List member](https://x-preview-add-redirects.mintlify.site/x-api/lists/add-a-list-member.md): Causes a User to become a member of a List. - [Remove a List member](https://x-preview-add-redirects.mintlify.site/x-api/lists/remove-a-list-member.md): Causes a User to be removed from the members of a List. - [Get a User's List Memberships](https://x-preview-add-redirects.mintlify.site/x-api/lists/get-a-users-list-memberships.md): Get a User's List Memberships. - [Returns User objects that follow a List by the provided List ID](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-follow-a-list-by-the-provided-list-id.md): Returns a list of Users that follow a List by the provided List ID - [Returns User objects that are members of a List by the provided List ID.](https://x-preview-add-redirects.mintlify.site/x-api/users/returns-user-objects-that-are-members-of-a-list-by-the-provided-list-id.md): Returns a list of Users that are members of a List by the provided List ID. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/lists/pinned-lists/introduction.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/lists/pinned-lists/quickstart/overview.md) - [Pinned list lookup](https://x-preview-add-redirects.mintlify.site/x-api/lists/pinned-lists/quickstart/pinned-list-lookup.md) - [Manage pinned lists](https://x-preview-add-redirects.mintlify.site/x-api/lists/pinned-lists/quickstart/manage-pinned-lists.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/lists/pinned-lists/integrate.md) - [Get a User's Pinned Lists](https://x-preview-add-redirects.mintlify.site/x-api/lists/get-a-users-pinned-lists.md): Get a User's Pinned Lists. - [Pin a List](https://x-preview-add-redirects.mintlify.site/x-api/lists/pin-a-list.md): Causes a User to pin a List. - [Unpin a List](https://x-preview-add-redirects.mintlify.site/x-api/lists/unpin-a-list.md): Causes a User to remove a pinned List. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/spaces/introduction.md) - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/spaces/lookup/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/spaces/lookup/quickstart.md) - [Space lookup up Space IDs](https://x-preview-add-redirects.mintlify.site/x-api/spaces/space-lookup-up-space-ids.md): Returns a variety of information about the Spaces specified by the requested IDs - [Space lookup by their creators](https://x-preview-add-redirects.mintlify.site/x-api/spaces/space-lookup-by-their-creators.md): Returns a variety of information about the Spaces created by the provided User IDs - [Space lookup by Space ID](https://x-preview-add-redirects.mintlify.site/x-api/spaces/space-lookup-by-space-id.md): Returns a variety of information about the Space specified by the requested ID - [Retrieve Posts from a Space.](https://x-preview-add-redirects.mintlify.site/x-api/spaces/retrieve-posts-from-a-space.md): Retrieves Posts shared in the specified Space. - [Retrieve the list of Users who purchased a ticket to the given space](https://x-preview-add-redirects.mintlify.site/x-api/spaces/retrieve-the-list-of-users-who-purchased-a-ticket-to-the-given-space.md): Retrieves the list of Users who purchased a ticket to the given space - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/spaces/search/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/spaces/search/quickstart.md) - [Search for Spaces](https://x-preview-add-redirects.mintlify.site/x-api/spaces/search-for-spaces.md): Returns Spaces that match the provided query. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/communities/lookup/introduction.md) - [Communities lookup by Community ID.](https://x-preview-add-redirects.mintlify.site/x-api/communities/communities-lookup-by-community-id.md): Returns a Community. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/communities/search/introduction.md) - [Search Communities](https://x-preview-add-redirects.mintlify.site/x-api/communities/search-communities.md): Returns Communities that match search query - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/trends/trends-by-woeid/introduction.md) - [Trends](https://x-preview-add-redirects.mintlify.site/x-api/trends/trends.md): Returns the Trend associated with the supplied WoeId. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/trends/personalized-trends/introduction.md) - [Get personalized Trends](https://x-preview-add-redirects.mintlify.site/x-api/trends/get-personalized-trends.md): Returns Personalized trends for the authenticated user - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/media/introduction.md) - [Best practices](https://x-preview-add-redirects.mintlify.site/x-api/media/quickstart/best-practices.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/media/quickstart/media-upload-chunked.md) - [Image or subtitle media upload](https://x-preview-add-redirects.mintlify.site/x-api/media/image-or-subtitle-media-upload.md): Uploads an image or a subtitle using a single API call. - [Initialize a media upload request.](https://x-preview-add-redirects.mintlify.site/x-api/media/media-upload-initialize.md): Initialize a media upload request. - [Media upload resumable upload append endpoint.](https://x-preview-add-redirects.mintlify.site/x-api/media/media-upload-append.md): MediaUpload - [Finalize a media upload request.](https://x-preview-add-redirects.mintlify.site/x-api/media/media-upload-finalize.md): Finalize a media upload request. - [Media Upload Status](https://x-preview-add-redirects.mintlify.site/x-api/media/media-upload-status.md): Get MediaUpload Status - [Metadata Create](https://x-preview-add-redirects.mintlify.site/x-api/media/metadata-create.md): MetadataCreate - [Subtitle Create](https://x-preview-add-redirects.mintlify.site/x-api/media/subtitle-create.md): SubtitleCreate - [Subtitle Delete](https://x-preview-add-redirects.mintlify.site/x-api/media/subtitle-delete.md): SubtitleDelete - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/usage/introduction.md) - [Post Usage](https://x-preview-add-redirects.mintlify.site/x-api/usage/post-usage.md): Returns the Post Usage. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/compliance/batch-compliance/introduction.md) - [Quickstart](https://x-preview-add-redirects.mintlify.site/x-api/compliance/batch-compliance/quickstart.md) - [Integration guide](https://x-preview-add-redirects.mintlify.site/x-api/compliance/batch-compliance/integrate.md) - [List Compliance Jobs](https://x-preview-add-redirects.mintlify.site/x-api/compliance/list-compliance-jobs.md): Returns recent Compliance Jobs for a given job type and optional job status - [Create compliance job](https://x-preview-add-redirects.mintlify.site/x-api/compliance/create-compliance-job.md): Creates a compliance for the given job type - [Get Compliance Job](https://x-preview-add-redirects.mintlify.site/x-api/compliance/get-compliance-job.md): Returns a single Compliance Job by ID - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/compliance/streams/introduction.md) - [Likes Compliance stream](https://x-preview-add-redirects.mintlify.site/x-api/compliance/likes-compliance-stream.md): Streams 100% of compliance data for Users - [Posts Compliance stream](https://x-preview-add-redirects.mintlify.site/x-api/compliance/posts-compliance-stream.md): Streams 100% of compliance data for Posts - [Users Compliance stream](https://x-preview-add-redirects.mintlify.site/x-api/compliance/users-compliance-stream.md): Streams 100% of compliance data for Users - [Analytics of posts](https://x-preview-add-redirects.mintlify.site/x-api/posts/get-engagement-analytics.md): Returns analytics of posts. - [Analytics of Media](https://x-preview-add-redirects.mintlify.site/x-api/media/get-media-analytics.md): Returns analytics of Media. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/introduction.md) - [Overview](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/migrate/overview.md) - [Check if a subscription exists for a given webhook and user](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/check-if-a-subscription-exists-for-a-given-webhook-and-user.md): Check if a subscription exists for a given webhook and user. - [Deactivates a subscription for the specified webhook and user id](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/deactivates-a-subscription-for-the-specified-webhook-and-user-id.md): Deactivates a subscription for the specified webhook and user id. - [Get a count of subscriptions that are currently active on your account](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/get-a-count-of-subscriptions-that-are-currently-active-on-your-account.md): Get a count of subscriptions that are currently active on your account. - [Get a list of the current All Activity type subscriptions for the specified webhook](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/get-a-list-of-the-current-all-activity-type-subscriptions-for-the-specified-webhook.md): Get a list of the current All Activity type subscriptions for the specified webhook. - [Request Activity Replay](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/request-activity-replay.md): Submits a request to retrieve activities from up to the past five days for all subscriptions associated with the specified webhook during the date and time windows provided. - [Subscribes the provided application to all events for the provided user context for all message types](https://x-preview-add-redirects.mintlify.site/x-api/account-activity/subscribes-the-provided-application-to-all-events-for-the-provided-user-context-for-all-message-types.md): Subscribes the provided application to all events for the provided user context for all message types. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/webhooks/introduction.md) - [Create Webhook Config](https://x-preview-add-redirects.mintlify.site/x-api/webhooks/create-webhook-config.md): Creates a new webhook config. - [Delete Webhook Config](https://x-preview-add-redirects.mintlify.site/x-api/webhooks/delete-webhook-config.md): Deletes a webhook config. - [Get a list of webhook configs associated with a client app](https://x-preview-add-redirects.mintlify.site/x-api/webhooks/get-a-list-of-webhook-configs-associated-with-a-client-app.md): Get a list of webhook configs associated with a client app. - [Webhook CRC Check](https://x-preview-add-redirects.mintlify.site/x-api/webhooks/webhook-crc-check.md): Manually trigger a CRC check for a webhook. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-api/posts/volume-streams/introduction.md) - [Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/firehose-stream.md): Streams 100% of public Posts. - [English Language Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/english-language-firehose-stream.md): Streams 100% of English Language public Posts. - [Japanese Language Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/japanese-language-firehose-stream.md): Streams 100% of Japanese Language public Posts. - [Korean Language Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/korean-language-firehose-stream.md): Streams 100% of Korean Language public Posts. - [Portuguese Language Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/portuguese-language-firehose-stream.md): Streams 100% of Portuguese Language public Posts. - [Sample stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/sample-stream.md): Streams a deterministic 1% of public Posts. - [Sample 10% stream](https://x-preview-add-redirects.mintlify.site/x-api/posts/sample-10-stream.md): Streams a deterministic 10% of public Posts. - [Likes Firehose stream](https://x-preview-add-redirects.mintlify.site/x-api/likes/likes-firehose-stream.md): Streams 100% of public Likes. - [Likes Sample 10 stream](https://x-preview-add-redirects.mintlify.site/x-api/likes/likes-sample-10-stream.md): Streams 10% of public Likes. - [Gnip console](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/overview.md) - [Data dictionary: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/data-dictionary.md): Interested in learning more about how the enterprise data formats map to the X API v2 format? - [Data enrichments: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/data-enrichments.md) - [Rules and filtering: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/rules-filtering.md) - [Rate limits: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/rate-limits.md) - [Edit Tweets](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/edit-tweets.md) - [Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/enterprise-gnip.md) - [PowerTrack API](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/powertrack-api.md) - [Decahose API](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/decahose-api.md) - [Account Activity API: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/account-activity.md) - [Search API: Enterprise](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/search-api.md) - [Engagement API](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/engagement-api.md) - [Compliance Firehose API](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/firehouse.md) - [Usage API](https://x-preview-add-redirects.mintlify.site/x-api/enterprise-gnip-2.0/fundamentals/usage.md): The Usage API is a free REST API that provides programmatic access and visibility into activity consumption across products for your enterprise account. - [Introduction](https://x-preview-add-redirects.mintlify.site/x-ads-api/introduction.md) - [Step-by-step guide](https://x-preview-add-redirects.mintlify.site/x-ads-api/getting-started/step-by-step-guide.md) - [Increasing access](https://x-preview-add-redirects.mintlify.site/x-ads-api/getting-started/increasing-access.md) - [Ads API hierarchy and terminology](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/hierarchy-and-terminology.md) - [Accessing Ads accounts](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/accessing-ads-accounts.md) - [Making Authenticated Requests](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/making-authenticated-requests.md) - [Error codes and responses](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/error-codes-and-responses.md) - [Rate limiting](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/rate-limiting.md) - [Pagination](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/pagination.md) - [Sorting](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/sorting.md) - [Versions](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/versioning.md) - [Timezones](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/timezones.md) - [Currency](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/currency.md) - [Sandbox](https://x-preview-add-redirects.mintlify.site/x-ads-api/fundamentals/sandbox.md) - [Tools and libraries](https://x-preview-add-redirects.mintlify.site/x-ads-api/tools-and-libraries.md) - [Analytics](https://x-preview-add-redirects.mintlify.site/x-ads-api/analytics.md) - [Audiences](https://x-preview-add-redirects.mintlify.site/x-ads-api/audiences.md) - [Campaign Management](https://x-preview-add-redirects.mintlify.site/x-ads-api/campaign-management.md) - [Catalog Management](https://x-preview-add-redirects.mintlify.site/x-ads-api/catalog-management.md) - [Creatives](https://x-preview-add-redirects.mintlify.site/x-ads-api/creatives.md) - [Mobile Conversions](https://x-preview-add-redirects.mintlify.site/x-ads-api/measurement/mobile-conversions.md) - [Web conversions](https://x-preview-add-redirects.mintlify.site/x-ads-api/measurement/web-conversions.md) - [AB Testing](https://x-preview-add-redirects.mintlify.site/x-ads-api/measurement/ab-testing.md) - [Explore a user’s Posts and mentions with the X API v2](https://x-preview-add-redirects.mintlify.site/tutorials/explore-a-users-posts.md): The user Post timeline and user mention timeline endpoints allow developers to retrieve the public Posts composed by, or mentioning a user. - [Getting started with Postman](https://x-preview-add-redirects.mintlify.site/tutorials/postman-getting-started.md): In this tutorial, we will discuss what Postman is and how to quickly get set up with it. - [Getting historical Posts using the v2 full-archive search endpoint](https://x-preview-add-redirects.mintlify.site/tutorials/getting-historical-posts-using-the-full-archive-search-endpoint.md) - [Build for businesses](https://x-preview-add-redirects.mintlify.site/use-cases/build-for-business.md): Use X's powerful APIs to help your business listen, act, and discover. - [Build for the public](https://x-preview-add-redirects.mintlify.site/use-cases/build-for-consumers.md): Build for people on X, to enhance and improve their experience on the platform. - [Do research](https://x-preview-add-redirects.mintlify.site/use-cases/do-research.md): Use the X API to get historical and real-time data points for your next research project. - [Teach and learn](https://x-preview-add-redirects.mintlify.site/use-cases/teach-and-learn.md): Teach or learn valuable skills with the X API. - [Build for good](https://x-preview-add-redirects.mintlify.site/use-cases/build-for-good.md): Make the world, and X, a better place. - [Build for fun](https://x-preview-add-redirects.mintlify.site/use-cases/build-for-fun.md): Begin using the X API in seconds with one of our access plans. - [Success Stories](https://x-preview-add-redirects.mintlify.site/success-stories.md) - [X Developer Platform Status](https://x-preview-add-redirects.mintlify.site/status.md) - [Incident History](https://x-preview-add-redirects.mintlify.site/incidents.md) - [Changelog](https://x-preview-add-redirects.mintlify.site/changelog.md): The X Developer Platform is updated frequently with new functionality and products to better suit your needs. We will be documenting all changes made to the platform’s products via this resource and the @API X account. ## OpenAPI Specs - [openapi](https://x-preview-add-redirects.mintlify.site/openapi.json) ## Optional - [Developer Portal](https://developer.x.com/en/portal/petition/essential/basic-info) - [Forums](https://devcommunity.x.com) - [GitHub](https://github.com/xdevplatform)