@font-face {
    font-family: "GraphikWide";
    src: url("https://mintlify-assets.b-cdn.net/x/GraphikWide-Semibold-Trial.woff") format("woff");
    font-weight: 600;
}

.font-branded, h1, h2, h3  {
  font-family: "GraphikWide";
  letter-spacing: -1%;
}

Developer Portal

Forums

GitHub

Home

Resources

X API

X Ads API

Tutorials

Use Cases

Customer Directory

Partner Directory

Changelog

Developer portal

Support

Causes a User to become a member of a List.

Add a List member

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

oauth2UserToken

UserToken

Platform overview

Developer Apps

Projects

Authentication

Counting characters

Rate limits

X IDs

Security

Tools and libraries

Instructions and examples to help you get started.

API Reference Index

Introduction

About the X API

Getting access

How to get access to the X API

Make your first request

Make your first request to the X API

Important resources

Overview

SDKs

Data Formation Migration

X API endpoint map

What to build

Enterprise data customers

X Official Partner

Twitter API v2 data dictionary

Fields

Expansions

Tweet Annotations

Metrics

Conversation id

Pagination

Versioning

Consistency

Edit Tweets

Tweets lookup

Manage Tweets

The X API v2 has three timelines endpoints - reverse chronological home timeline, user Post timeline, and user mention timeline. See below for more details.

Timelines

Search tweets

Tweet counts

Filtered stream

Volume streams consist of two streaming endpoints that deliver a random sample of publicly available Posts in real-time. They are available to Enterprise levels of access only.

Volume Streams

Retweeting is one of the core features people use to engage in the public conversation on X. With the Retweets lookup endpoints, you can see a list of accounts that Retweeted a given POst. In addition, the new manage Retweets endpoints allow you to Retweet a Post or undo a Retweet.

Retweets

The Quote Tweets lookup endpoint gives the Quote Tweets for a given Post ID.  This allows developers that build apps and clients to get the Quote Tweets for a Post quickly and efficiently. It also makes it easy for researchers to study the full conversation around a Post including all its Quote Tweets.

Quote Tweets

Liking Posts is one of the core features people use to engage in the public conversation on  X. With endpoints in our Likes lookup endpoint group, you can see a list of accounts that have liked a given Post, or which Posts a given account has liked. You could use these endpoints to understand what kind of content a specified account or group of accounts likes. 

Likes

Bookmarks are a core feature of the X app that allows you to “save” Posts and easily access them later. With these endpoints, you can retrieve, create, delete or build solutions to manage your Bookmarks via the API

Bookmarks

Many people want the benefit of hiding replies to improve the quality of their conversations. Sometimes it’s difficult or overwhelming to do so without help, particularly when people receive a large number of replies, when those replies contain offensive or abusive language, or when they want to confine certain conversations to specific groups like close friends.

Hide replies

The RESTful endpoint uses the GET method to return information about a user or group of users, specified by a user ID or a username. The response includes one or many [user objects](/x-api/x-api-v2/fundamentals/data-dictionary#user), which deliver fields such as the Follower count, location, pinned Post ID, and profile bio. Responses can also optionally include expansions to return the full Post object for a user’s pinned Post, including the Post text, author, and other Post fields. 

Users lookup

Following users is one of the most foundational actions on X. 

Follows

Using blocks lookup, you can see who you or an authenticated user has blocked. This can be useful for determining how you can interact with a given account. 

Blocks

Mutes

Search

Personalized Trends

Tweets

Trends by WOEID

Spaces overview

The Spaces lookup endpoints help you lookup live or scheduled Spaces, and enable you to build discovery experiences to give your users ways to find Spaces they may be interested in.

Spaces lookup

Search Spaces

Direct Messages enable private conversations on X. Direct Messages are one of the most popular features of X, with a wide variety of use cases. These use cases range from group chats among friends to powering customer support for brands around the world. New v2 versions of Direct Messages endpoints will be introduced in stages, and this first stage includes fundamental endpoints for creating Direct Messages and listing Direct Message conversation events. For the first time, the X API v2 supports _group_ conversations.

Direct Messages lookup

Manage Direct Message Blocks

This List lookup group has two available endpoints. You are able to retrieve a specified List by ID and get details on user-owned Lists. With the Lists endpoints, you can build solutions that enable people to curate and organize Posts based on preferences, interests, groups, or topics. 

List lookup

Manage Lists

List Tweets lookup

List members

Pinned Lists

The Communities lookup endpoint helps you lookup Communities by their ID, and enables you to build experiences to display information about Communities that your users are interested in.

Communities lookup

Search Communities

Batch compliance

Compliance Streams

Gnip console

Interested in learning more about how the enterprise data formats map to the X API v2 format?

Data dictionary

Data dictionary: Enterprise

Data enrichments: Enterprise

Rules and filtering: Enterprise

Rate limits: Enterprise

Enterprise

PowerTrack API

Decahose API

Account Activity API: Enterprise

Search API

Search API: Enterprise

Engagement API

Compliance Firehose API

The Usage API is a free REST API that provides programmatic access and visibility into activity consumption across products for your enterprise account.

Usage API

Step-by-step guide

Increasing access

Subscribe for updates

Ads API hierarchy and terminology

Accessing Ads accounts

Making Authenticated Requests

Error codes and responses

Rate limiting

Sorting

Versions

Timezones

Currency

Sandbox

Analytics

Audiences

Campaign Management

Catalog Management

Creatives

Mobile Conversions

Web conversions

AB Testing

The oEmbed API returns simple embed HTML in an [oEmbed](http://oembed.com/)-compatible format.

oEmbed API

The user Post timeline and user mention timeline endpoints allow developers to retrieve the public Posts composed by, or mentioning a user.

Explore a user’s Posts

Explore a user’s Posts and mentions with the X API v2

In this tutorial, we will discuss what Postman is and how to quickly get set up with it.

Getting started with Postman

Getting historical Posts using the v2 full-archive search endpoint

Use X's powerful APIs to help your business listen, act, and discover.

Build for businesses

Build for people on X, to enhance and improve their experience on the platform.

Build for the public

Use the X API to get historical and real-time data points for your next research project.

Do research

Teach or learn valuable skills with the X API.

Teach and learn

Build for good

Begin using the X API in seconds with one of our access plans.

Build for fun

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.

Returns Post Counts that match a search query.

Full archive search counts

Returns Post Counts from the last 7 days that match a search query.

Recent search counts

Full-archive search

Returns Posts from the last 7 days that match a search query.

Recent search

Streams Posts matching the stream's active rule set.

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 lookup

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.

Add/Delete rules

Returns a list of Posts authored by the provided User ID

User Posts timeline by User ID

Returns Post objects that mention username associated to the provided User ID

User mention timeline by User ID

Returns Post objects that appears in the provided User ID's home timeline

User home timeline by User ID

Returns a variety of information about the Post specified by the requested ID.

Post lookup by Post IDs

Post lookup by Post ID

Returns Post objects that have been bookmarked by the requesting User

Bookmarks by User

Adds a Post (ID in the body) to the requesting User's (in the path) bookmarks

Add Post to Bookmarks

Removes a Post from the requesting User's bookmarked Posts.

Remove a bookmarked Post

Causes the User to create a Post under the authorized account.

Creation of a Post

Delete specified Post (in the path) by ID.

Post delete by Post ID

Returns a list of Users that have retweeted the provided Post ID

Returns User objects that have retweeted the provided Post ID

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 repost the specified Post.

Causes the User (in the path) to unretweet the specified Post. The User must match the User context authorizing the request

Causes the User (in the path) to unretweet the specified Post

Returns a variety of information about each Post that has retweeted the Post specified by the requested ID.

X API

X API v2

Enterprise - Gnip 2.0

Posts

Users

Engagement Metrics

Direct Messages

Lists

Spaces

Likes

Trends

Usage

General

Compliance

Add a List member

Authorizations

Path Parameters

Body

Response