Likes

​

Introduction

​

Likes lookup

With endpoints in the Likes lookup group, you can retrieve a list of accounts that have liked a Post, or a list of Posts that an account has liked. These endpoints include:

• Posts liked by a user - GET /2/users/:id/liked_tweets
• Users who have liked a Post - GET /2/tweets/:id/liking_users

You can authenticate these endpoints with either OAuth 1.0a User Context or OAuth 2.0 Bearer Token. For the liked Posts endpoints, pagination tokens will be provided for paging through large sets of results.

The liking users endpoint limits you to a total of 100 liking accounts per post for all time.  Additionally, the liked Posts endpoint is also subject to the monthly Post cap applied at the Project level.  

​

Manage Likes

The manage Likes endpoints enable you to like or unlike a specified Post on behalf of an authenticated account. For this endpoint group, there are two methods available POST and DELETE. The POST method allows you to like a Post, and the DELETE method will enable you to unlike a Post.

Since you are making requests on behalf of a user, you must authenticate these endpoints with OAuth 1.0a User Context and use the Access Tokens associated with the user, which can be generated using the 3-legged OAuth flow/obtaining-user-access-tokens). You can like a Post from your account or an account of an authenticated user. With both endpoints, there is a user rate limit of 50 requests per 15 minutes per endpoint.   

To access these endpoint, you must have an approved developer account. When authenticating, you must use keys and tokens from a developer App that is located within a Project. 

Learn more about getting access to the X API v2 endpoints in our getting started page.

​

Quick Start

​

Getting started with the Likes lookup endpoint

This quick start guide will help you make your first request to the Likes lookup endpoint using Postman.

If you would like to see sample code in different languages, please visit our Twitter API v2 sample code GitHub repository.  

​

Prerequisites

For you to be able to complete this guide, you will have need to have a set of keys and tokens, which you can generate by following these steps:

1. Apply for a developer account and receive approval.

2. Create a Project and an associated developer App in the developer portal.

3. Navigate to your app’s “Keys and tokens” page, and save your API Keys, Access Tokens, and Bearer Token to your password manager.

​

Steps to build a Likes lookup request

Step one: Start with a tool or library

There are several different tools, code examples, and libraries that you can use to make a request to this endpoint, but we will use the Postman tool here to simplify the process.

To load the Twitter API v2 Postman collection into your environment, please click on the following button:

Add Twitter API v2 to Postman

Once you have the Twitter API v2 collection loaded in Postman, navigate to the “Likes” folder and select “Liking users.”   

Step two: Authenticate your request

To make a successful request to this endpoint, you will need to use either OAuth 1.0a User Context or OAuth 2.0 Bearer Token authentication. To do this, you must add the following keys and tokens to Postman by selecting the environment named “Twitter API v2”, and adding the following variables to the Initial value and Current value fields:

• consumer_key with your API Key
• consumer_secret with your API Key Secret
• access_token with your Access Token
• token_secret with your Access Token Secret  

Step three: Specify a Tweet

With this endpoint, you must specify the Tweet ID that you want to get liking users for. You can find the ID of a Tweet by navigating to that Tweet on Twitter and pulling the numerical code at the end of the URL. For example, the following URL’s Tweet ID is 1354143047324299264.

https://twitter.com/TwitterDev/status/1354143047324299264

In Postman, navigate to the “Params” tab and enter this username into the “Value” column of the tweet_id path variable (at the bottom of the section), making sure to not include any spaces before or after usernames. 

Step four: Identify and specify which fields you would like to retrieve

If you click the “Send” button after step three, you will receive the default user object fields in your response: id, name, and username.

If you would like to receive additional fields beyond id, name, and username, you will have to specify those fields in your request with the fields and/or expansions parameters.

For this exercise, we will request three additional sets of fields from different objects:

1. The additional user.created_at field in the primary user objects.
2. The associated pinned Tweets’ object’s default fields for the returned users: id and text.
3. The additional  tweet.created_at field in the associated Tweet objects.

In Postman, navigate to the “Params” tab and add the following key:value pair to the “Query Params” table:

You should now see the following URL next to the “Send” button:

https://api.x.com/2/tweets/1354143047324299264/liking_users?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

Step five: Make your request and review your response

Once you have everything set up, hit the “Send” button and you will receive a similar response to the following example response:

{
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Twitter Support"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "TwitterAPI",
      "name": "Twitter API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "now, everyone with 600 or more followers can host a Space.\n\nbased on what we've learned, these accounts are likely to have a good experience hosting because of their existing audience. before bringing the ability to create a Space to everyone, we’re focused on a few things. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "Twitter API v2: Early Access released\n\nToday we announced Early Access to the first endpoints of the new Twitter API!\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }
}

Step six: Get a user’s liked Tweets

You might also want to make a request to get a user’s liked Tweets as well. With the Likes lookup endpoint, you can get information about a user’s liked Tweets. To do this navigate to the “Likes” folder and select “Liked Tweets”. 

With this endpoint, you must specify the User ID that you want to get liking users for. You can use the user lookup endpoint to get this information.

In Postman, navigate to the “Params” tab and enter this username into the “Value” column of the id path variable (at the bottom of the section), making sure to not include any spaces before or after usernames. 

You can now see a similar URL with your ID instead of TwitterDev’s next to the “Send” button:  

https://api.x.com/2/users/2244994945/liked_tweets?max_results=5

Once you have everything set up, hit the “Send” button and you will receive a similar response to the following example response:

{
  "data": [
    {
      "id": "1362449997430542337",
      "text": "Honored to be the first developer to be featured in @TwitterDev's love fest 🥰♥️😍 https://t.co/g8TsPoZsij"
    },
    {
      "id": "1365416026435854338",
      "text": "We're so happy for our Official Partner @Brandwatch and their big news. https://t.co/3DwWBNSq0o https://t.co/bDUGbgPkKO"
    },
    {
      "id": "1296487407475462144",
      "text": "Check out this feature on @TwitterDev to learn more about how we're mining social media data to make sense of this evolving #publichealth crisis https://t.co/sIFLXRSvEX."
    },
    {
      "id": "1294346980072624128",
      "text": "I awake from five years of slumber https://t.co/OEPVyAFcfB"
    },
    {
      "id": "1283153843367206912",
      "text": "@wongmjane Wish we could tell you more, but I’m only a teapot 👀"
    }
  ],
  "meta": {
        "next_token": "7140dibdnow9c7btw4539n0vybdnx19ylpayqf16fjt4l",
    	  "result_count": 5
  }
}

​

Getting started with the manage Likes endpoints

This quick start guide will help you make your first request to the manage Likes endpoints using Postman.

If you would like to see sample code in different languages, please visit our X API v2 sample code GitHub repository. 

​

Prerequisites

For you to be able to complete this guide, you will have need to have a set of keys and tokens, which you can generate by following these steps:

1. Apply for a developer account and receive approval.

2. Create a Project and an associated developer App in the developer portal.

3. Navigate to your app’s “Keys and tokens” page, and save your API Keys, Access Tokens, and Bearer Token to your password manager.

​

Steps to build a manage Likes request

Step one: Start with a tool or library

There are several different tools, code examples, and libraries that you can use to make a request to this endpoint, but we are going to use the Postman tool here to simplify the process.

To load the X API v2 Postman collection into your environment, please click on the following button:

Add X API v2 to Postman

Once you have the X API v2 collection loaded in Postman, navigate to the “Likes” folder, and select “Like a Post”.

Step two: Authenticate your request

To make a successful request to this endpoint, you will need to use OAuth 1.0a User Context. To do this, you must add the following keys and tokens to Postman by selecting the environment named “X API v2”, and adding the following variables to the initial value and current value fields:

• consumer_key with your API Key
• consumer_secret with your API Key Secret
• access_token with your Access Token
• token_secret with your Access Token Secret  

Step three: Specify which Post you are going to like

Manage Likes endpoints require two IDs: one for the user (the user who wishes to like a Post), and the other representing the  Post ID that the user is trying to like or unlike. 

The user’s ID must correspond to the authenticating user’s ID, meaning that you must pass the Access Tokens associated with the user ID when authenticating your request.  In this case, you can specify the ID belonging to your own user. You can find your ID in two ways:

1. Using the user lookup by username endpoint, you can pass a username and receive the id field. 
2. Looking at your Access Token, you will find that the numeric part is your user ID.  

You also must specify a Post that you want to like. You can find the Post ID by navigating to x.com and clicking on a Post and then looking in the URL. For example, the following URL’s Post ID is 1228393702244134912.

https://twitter.com/TwitterDev/status/1228393702244134912

In Postman, navigate to the “Params” tab, and enter your ID into the “Value” column of the id path variable. Navigate to the “Body” tab and ID of the Post you wish to like as the value for the tweet_id parameter. Be sure not to include any spaces before or after any ID.

If you click the “Send” button, you will receive a response object containing the status of the relationship:

• If you receive a “liked”: true, then the id is successfully liking the tweet_id.  

Step four: Make your request and review your response

Once you have everything set up, hit the “Send” button and you will receive the following response:

{
    "data": {
        "liked": true
    }
}

If you wish to unlike the same Post you can use the request entitled “Unlike a Post”, which is also found in the “Likes” folder of the X API v2 collection in Postman. The id and tweet_id should be used in the same way as the previous example.  To unlike a Post, you will not have to add this as a JSON body so you will want to make sure that you add in the requisite query params for id and tweet_id.

​

Comparing X API’s Likes endpoints

These guides will focus on the following areas:

• API request parameters - The X API v2 endpoint introduces a new set of request parameters. While some parameters will be familiar, especially for those integrating with Labs, there are many important differences such as the introduction of the fields and expansions parameters.

• App and Project requirements - To access the X API v2, you will need to use credentials from a developer App that is associated with a Project

​

Likes lookup

Users who have liked a Post

The liked users endpoint is new functionality for v2, allowing you to get information about a Post’s liking users.

Posts liked by a user

The following tables compare the standard v1.1 GET favorites/list endpoint and the X API v2 liked Posts endpoints:

​

Manage Likes

The v2 manage Likes endpoints replace the v1.1 POST favorites/create and POST favorites/destroy endpoints.

The following tables compare the standard v1.1 and X API v2 manage Like endpoints:

​

Like a Post

​

Unlike a Post

Other migration resources

Likes lookup: Standard v1.1 to X API v2

Manage Likes: Standard v1.1 to X API v2

X API migration hub

​

Likes lookup: Standard v1.1 compared to X API v2

If you have been working with the standard v1.1 GET favorites/list endpoint, the goal of this guide is to help you understand the similarities and differences between the standard v1.1 and X API v2 Likes lookup endpoints.

With v2, we’ve also introduced a new liked users endpoint which allows you to get information about a Post’s liking users.

• Similarities
  • Authentiation
  • Rate limits
• Differences

  • Endpoint URLs

  • Request limitations

  • App and Project requirements

  • Request parameters

  • New JSON format

​

Similarities

Authentication

Both the standard v1.1 and X API v2 Likes lookup endpoints use OAuth 1.0a User Context or OAuth 2.0 Bearer Token. Therefore, if you were previously using the GET favorites/list endpoints standard v1.1 endpoints, you can continue using the same authentication method if you migrate to the X API v2 version if you wish. 

Depending on your authentication library/package of choice, Bearer Token authentication is probably the easiest way to get started and can be set with a simple request header. To learn how to generate a Bearer Token, see this OAuth 2.0 Bearer Token guide.   

Rate limits

The standard v1.1 GET favorites/list endpoint has a 75 requests per 15 minutes per user rate limit. The corresponding liked Posts endpoint in v2 also has this same rate limit. However, this v2 endpoint also has an additional rate limit of 75 requests per 15 minutes per App.

​

Differences

Endpoint URLs

• Standard v1.1 endpoints:
  • GET https://api.x.com/1.1/favorites/list.json (list of Posts which are by the specified user)
  • There is no v1.1 equivalent to the v2 liking users endpoint
• X API v2 endpoint:
  • GET https://api.x.com/2/users/:id/liked_tweets (list of Posts which are liked by the specified user ID)
  • GET https://api.x.com/2/tweets/:id/liking_users (list of users who liked the specified Post ID)

Request limitations

The v2 liked Posts endpoint allows you to request 5 to 100 Posts per request, but you can request all likes of a Post using pagination tokens. The v1.1 GET favorites/list endpoint also allows you to pull all likes of Posts, but you can pull from 20 to 200 Posts per request.

For the v2 liking users endpoint, you are limited to 100 liking users per Post.   

App and Project requirements

The X API v2 endpoints require that you use credentials from a developer App that is associated with a Project when authenticating your requests. All X API v1.1 endpoints can use credentials from standalone Apps or Apps associated with a project.

Request parameters

The following standard v1.1 request parameters accepted two request query parameters (user_id or screen_name). The X API v2 only accepts the numerical user ID, and it must be passed as part of the endpoint path.

One of the biggest differences between standard v1.1 and X API v2 endpoint versions is how you select which fields return in your payload. For the standard endpoints, there are several parameters that you could use to identify which fields or sets of fields would return in the payload, while the X API v2 version simplifies these different parameters into fields and expansions.   

New JSON format

X API v2 is introducing new JSON designs for the objects returned by the APIs, including Post and user objects.

• At the JSON root level, the standard endpoints return user objects in a statuses array, while X API v2 returns a data array. 
• Instead of referring to Retweeted and Quoted “statuses”, X API v2 JSON refers to Retweeted and Quoted Tweets. Many legacy and deprecated fields, such as contributors and user.translator_type are being removed. 
• Instead of using both favorites (in Post object) and favourites (in user object), X API v2 uses the term like. 
• X is adopting the convention that JSON values with no value (for example, null) are not written to the payload. Post and user attributes are only included if they have non-null values.  

In addition to the changes that we made to our new JSON format, we also introduced a new set of fields to the Post object including the following:

• conversation_id
• Two new Post annotations fields, including context and entities
• Several new metrics fields 

​

Manage Likes: Standard v1.1 compared to X API v2

If you have been working with the standard v1.1 POST favorites/create and POST favorites/destroy endpoints, the goal of this guide is to help you understand the similarities and differences between the standard v1.1 and X API v2 manage Likes endpoints.

• Similarities
  • OAuth 1.0a User Context
• Differences
  • Endpoint URLs and HTTP methods
  • App and Project requirements
  • Request parameters

​

Similarities

OAuth 1.0a User Context authentication method

Both the endpoint versions support OAuth 1.0a User Context. Therefore, if you were previously using one of the standard v1.1 manage favorites endpoints, you can continue using the same authentication method if you migrate to the X API v2 version.

​

Differences

Endpoint URLs and HTTP methods

• Standard v1.1 endpoints:
  • POST https://api.x.com/1.1/favorites/create.json (like a Post)
  • POST https://api.x.com/1.1/favorites/destroy.json (unlike a Post)
• X API v2 endpoint:
  • POST https://api.x.com/2/tweets/:id/likes (like a Post)
  • DELETE https://api.x.com/2/tweets/:id/likes/:tweet_id (unlike a Post) 

App and Project requirements

The X API v2 endpoints require that you use credentials from a developer App that is associated to a Project when authenticating your requests. All X API v1.1 endpoints can use credentials from standalone Apps or Apps associated with a Project.

Request parameters

The following standard v1.1 request parameters have equivalents in X API v2:

Please note that the Standard v1.1 parameters are passed as query parameters, whereas the X API v2 parameters are passed as body parameters for the POST endpoint or path parameters for the DELETE endpoint.

Also, an id of the user liking a Post is not required when using the standard v1.1 endpoints since the Access Tokens passed with OAuth 1.0a User Context infer which user is initiating the like/unlike. 

​

API reference index

For the complete API reference, select an endpoint from the list:  

​

Likes lookup

​

Manage Likes

​

DELETE /2/users/:id/likes/:tweet_id

Allows a user or authenticated user ID to unlike a Tweet.

The request succeeds with no action when the user sends a request to a user they’re not liking the Tweet or have already unliked the Tweet.

​

Endpoint URL

https://api.x.com/2/users/:id/likes/:tweet_id

​

Authentication and rate limits

​

Path parameters

​

Example requests

• cURL
• twurl

curl -X DELETE https://api.x.com/2/users/2244994945/likes/1228393702244134912 -H "Authorization: OAuth $OAUTH_SIGNATURE"

​

Example responses

• Successful response

{
  "data": {
    "liked": false
  }
}

​

Response fields

​

GET /2/tweets/:id/liking_users

Allows you to get information about a Tweet’s liking users.

​

Endpoint URL

https://api.x.com/2/tweets/:id/liking_users

​

Authentication and rate limits

​

OAuth 2.0 scopes required by this endpoint

​

Path parameters

​

Query parameters

​

Example code with offical SDKs

• TypeScript (Default fields)
• TypeScript (Optional fields)
• Java (Default fields)
• Java (Optional fields)

(async () => {
  try {
    const likingUsers = await twitterClient.users.tweetsIdLikingUsers(
      // Tweet ID of the Tweet to request liking users of
      "1354143047324299264"
    );
    console.dir(likingUsers, {
      depth: null,
    });
  } catch (error) {
    console.log(error);
  }
})();

​

Example responses

• Default fields
• Optional fields

{
  "data": [
    {
      "id": "1065249714214457345",
      "name": "Spaces",
      "username": "TwitterSpaces"
    },
    {
      "id": "783214",
      "name": "Twitter",
      "username": "Twitter"
    },
    {
      "id": "1526228120",
      "name": "Twitter Data",
      "username": "TwitterData"
    },
    {
      "id": "2244994945",
      "name": "Twitter Dev",
      "username": "TwitterDev"
    },
    {
      "id": "6253282",
      "name": "Twitter API",
      "username": "TwitterAPI"
    }
  ]
}

​

Response fields

​

GET /2/users/:id/liked_tweets

Allows you to get information about a user’s liked Tweets.

The Tweets returned by this endpoint count towards the Project-level Tweet cap.

​

Endpoint URL

https://api.x.com/2/users/:id/liked_tweets

​

Authentication and rate limits

​

OAuth 2.0 scopes required by this endpoint

​

Path parameters

​

Query parameters

​

Example code with offical SDKs

• TypeScript (Default fields)
• TypeScript (Optional fields)
• Java (Default fields)
• Java (Optional fields)

(async () => {
  try {
    const usersLikedTweets = await twitterClient.tweets.usersIdLikedTweets(
      // The ID of the User to list the liked Tweets of
      "2244994945"
    );
    console.dir(usersLikedTweets, {
      depth: null,
    });
  } catch (error) {
    console.log(error);
  }
})();

​

Example responses

• Default fields
• Optional fields

{
  "data": [
    {
      "id": "1362449997430542337",
      "edit_history_tweet_ids": [
        "1362449997430542337"
      ],
      "text": "Honored to be the first developer to be featured in @TwitterDev's love fest 🥰♥️😍 https://t.co/g8TsPoZsij"
    },
    {
      "id": "1365416026435854338",
      "edit_history_tweet_ids": [
        "1365416026435854338"
      ],
      "text": "We're so happy for our Official Partner @Brandwatch and their big news. https://t.co/3DwWBNSq0o https://t.co/bDUGbgPkKO"
    },
    {
      "id": "1296487407475462144",
      "edit_history_tweet_ids": [
        "1296487407475462144"
      ],
      "text": "Check out this feature on @TwitterDev to learn more about how we're mining social media data to make sense of this evolving #publichealth crisis https://t.co/sIFLXRSvEX."
    },
    {
      "id": "1294346980072624128",
      "edit_history_tweet_ids": [
        "1294346980072624128"
      ],
      "text": "I awake from five years of slumber https://t.co/OEPVyAFcfB"
    },
    {
      "id": "1283153843367206912",
      "edit_history_tweet_ids": [
        "1283153843367206912"
      ],
      "text": "@wongmjane Wish we could tell you more, but I’m only a teapot 👀"
    }
  ]
}

​

Response fields

​

POST /2/users/:id/likes

Causes the user ID identified in the path parameter to Like the target Tweet.

​

Endpoint URL

https://api.x.com/2/users/:id/likes

​

Authentication and rate limits

​

OAuth 2.0 scopes required by this endpoint

​

Path parameters

​

JSON body parameters

​

Example code with offical SDKs

• TypeScript
• Java

(async () => {
  try {
    const likeTweet = await twitterClient.tweets.usersIdLike(
      // The ID of the user that is requesting to like the tweet
      "1324848235714736129",

      {
        // The ID of the tweet that the user is requesting to like
        tweet_id: "1521887626935947265",
      }
    );
    console.dir(likeTweet, {
      depth: null,
    });
  } catch (error) {
    console.log(error);
  }
})();

​

Example responses

• Successful response

{
  "data": {
    "liked": true
  }
}

​

Response fields

​

DELETE /2/users/:id/likes/:tweet_id

Allows a user or authenticated user ID to unlike a Tweet.

The request succeeds with no action when the user sends a request to a user they’re not liking the Tweet or have already unliked the Tweet.

​

Endpoint URL

https://api.x.com/2/users/:id/likes/:tweet_id

​

Authentication and rate limits

​

OAuth 2.0 scopes required by this endpoint

​

Path parameters

​

Example code with offical SDKs

• TypeScript
• Java

(async () => {
  try {
    const unlikeTweet = await twitterClient.tweets.usersIdUnlike(
      // The ID of the user that is requesting to unlike the tweet
      "2244994945",

      // The ID of the tweet that the user is requesting to unlike
      "1228393702244134912"
    );
    console.dir(unlikeTweet, {
      depth: null,
    });
  } catch (error) {
    console.log(error);
  }
})();

​

Example responses

• Successful response

{
  "data": {
    "liked": false
  }
}

​

Response fields