Standard v1.1 compared to X API v2
If you have been working with the standard v1.1 GET statuses/show and GET statuses/lookup, the goal of this guide is to help you understand the similarities and differences between the standard and X API v2 Posts lookup endpoints..
You may also be interested in our visual data format migration tool to help you quickly see the differences between the X API v1.1 data format and the X API v2 format.
- Similarities
- OAuth 1.0a User Context
- Posts per request limits
- Support for Post edit history and metadata
- Differences
- Endpoint URLs
- App and Project requirements
- Response data format
- Request parameters
Similarities
OAuth 1.0a User Context authentication method
The standard endpoint supports OAuth 1.0a User Context, while the new X API v2 Post lookup endpoint supports both OAuth 1.0a User Context and OAuth 2.0 App-Only. Therefore, if you were previously using one of the standard v1.1 Post lookup endpoints, you can continue using the same authentication method if you migrate to the X API v2 version.
Depending on your authentication library/package of choice, App-Only authentication is probably the easiest way to get started and can be set with a simple request header. To learn how to generate an App Access Token, see this OAuth 2.0 App-only guide.
Posts per request limits
The v1.1 GET statuses/lookup endpoint allows you to specify 100 Posts per request. This also goes for the GET /tweets endpoint. To specify a full 100 Posts, you will need to pass the ids parameter as a query parameter rather than a path parameter and include the list of Post IDs in a comma-separated list.
Support for Post edit history and metadata
Both versions provide metadata that describes any edit history. Check out the Post lookup API References and the Edit Posts fundamentals page for more details.
Differences
Endpoint URLs
- Standard v1.1 endpoints:
- https://api.x.com/1.1/statuses/show
- https://api.x.com/1.1/statuses/lookup
- X API v2 endpoint:
- https://api.x.com/2/tweets
- https://api.x.com/2/tweets/:id
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.
Response data format
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, you receive many of the response fields by default, and then have the option to use parameters to identify which fields or sets of fields should return in the payload.
The X API v2 version only delivers the Post id and text fields by default. To request any additional fields or objects, you will need to use the fields and expansions parameters. Any Post fields that you request from these endpoints will return in the primary Post object. Any expanded user, media, poll, or place objects and fields will return in an includes object within your response. You can then match any expanded objects back to the Post object by matching the IDs located in both the Post and the expanded object.
We encourage you to read more about these new parameters in their respective guides, or by reading our guide on how to use fields and expansions.
We have also put together a data format migration guide which can help you map standard v1.1 fields to the newer v2 fields. This guide will also provide you the specific expansion and field parameter that you will need to pass with your v2 request to return specific fields.
In addition to the changes in how you request certain fields, X API v2 is also 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 Post 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 a non-null values.
We also introduced a new set of fields to the Post object including the following:
- A conversation_id field
- Two new annotations fields, including context and entities
- Several new metrics fields
- A new reply_setting field, which shows you who can reply to a given Post
Request parameters
The following standard v1.1 request parameters have equivalents in X API v2:
Standard | X API v2 |
id | ids |
There are also a set of standard v1.1 Post lookup request parameters not supported in X API v2:
Standard | Comment |
---|---|
tweet_mode | This parameter enables developers to request a series of different extended fields that had been introduced in the years since statuses/show and statuses/lookup were introduced. It has been replaced with the fields and expansions functionality. |
trim_user | This parameter is used to reduce the number of fields that deliver in the user object that comes alongside each Post. It has been replaced with the additive fields and expansions functionality. To request user information alongside your requested Post, you will need to use a combination of the author_id expansion and the user.fields parameter with a set of specified user fields. |
include_my_retweet | This parameter includes the ID of the source Post for those specified Posts that were Retweeted by the authenticating user. |
include_entities | This parameter is used to remove the entities node from the Post payload. It has been replaced with the additive fields and expansions functionality. |
include_ext_alt_text | This parameter adds an additional ext_alt_text field in the media entity if that media has alt text attached to it. |
include_card_uri | This parameters adds a card_uri attribute when there is an ads card attached. |
map | This parameter would return the Post ID and nullified fields for unavailable Posts. In v2, we return the Post ID and a detailed error message for unavailable Posts. |
CURL requests
The following section displays cURL requests for the standard v1.1 endpoints and their equivalent endpoints in v2.
The requests are made using OAuth 2.0 App-Only. In order to run the following cURL requests, you will need to replace ACCESS_TOKEN in the authorization header with your app access token. For v2 endpoints, your app access token must belong to a developer App within a Project.
The response payloads returned by v1.1 endpoints will be different from the response payloads returned by v2 endpoints. With v2, responses will include the default fields, as well as any other fields requested with the fields and expansions parameters. You can use these parameters to request a different set of fields to be returned.
Standard v1.1 GET statuses/lookup and v2 GET /tweets endpoints
curl --request GET \
--url 'https://api.x.com/1.1/statuses/lookup.json?id=1460323737035677698%2C1460323743339741184' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
curl --request GET \
--url 'https://api.x.com/2/tweets?ids=1460323737035677698%2C1460323743339741184&tweet.fields=created_at&expansions=author_id&user.fields=created_at' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
Standard v1.1 GET statuses/show/:id and v2 GET /tweets/:id endpoints
curl --request GET \
--url 'https://api.x.com/1.1/statuses/show.json?id=1460323737035677698' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
curl --request GET \
--url 'https://api.x.com/2/tweets/1460323737035677698?tweet.fields=created_at&expansions=author_id&user.fields=created_at' \
--header 'Authorization: Bearer $ACCESS_TOKEN'