Skip to main content

​
Standard v1.1 compared to X API v2

If you have been working with the v1.1 statuses/filter endpoint, this guide can help you understand the similarities and differences between the standard and X API v2 filtered stream endpoints.
  • Similarities
    • Request parameters and operators
    • Support for Post edit history and metadata
  • Differences
    • Endpoint URLs
    • App and Project requirement
    • Authentication method
    • Rule volume and persistent stream
    • Response data format
    • Request parameters
    • Availability of recovery and redundancy features
    • Query operators

​
Similarities

Request parameters and operators The standard v1.1 statuses/filter endpoint features a few parameters that can be passed along with the request to filter the stream. With v2 filtered stream, you instead use a set of operators that can be connected together using boolean logic to filter for desired Posts. The available operators include some that are direct replacements for the existing standard v1.1 parameters.  The following standard v1.1 request parameters have equivalent operators in X API v2:  
StandardX API v2
follow - A comma-separated list of user IDs, indicating the users whose Posts should be delivered on the stream.Many operators that can help you find Posts related to specific users:

* @
* from:
* to:
* etc.
track - A comma-separated list of phrases which will be used to determine what Posts will be delivered on the stream.Many operators that can help you find Posts related to specific keywords:

* keyword
* “exact phrase match”
* #
* etc.
Support for Post edit history and metadata Both versions provide metadata that describes any edit history. Check out the filtered stream API References and the Post edits fundamentals page for more details. 

​
Differences

Endpoint URLs 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. Authentication method The standard endpoint supports OAuth 1.0a User Context, whereas the X API v2 filtered stream endpoints supports OAuth 2.0 App-Only (also referred to as Application-only authentication). To make requests to the X API v2 version you must use a App Access Token to authenticate your requests. If you no longer have the App Access Token that was presented to you when you created your Project and app in the developer portal, you can generate a new one by navigating to your app’s “Keys and tokens” page on the developer portal. If you’d like to generate an App Access Token programmatically, see this OAuth 2.0 App-Only guide.  Rule volume and persistent stream The standard v1.1 endpoint supports a single rule to filter the streaming connection. To change the rule, you have to disconnect the stream and submit a new request with the revised filtering rules submitted as parameters.  The X API v2 filtered stream endpoint allows you to apply multiple rules to a single stream and add and remove rules to your stream while maintaining the stream connection.  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 wil 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 There are also a set of standard filtered stream request parameters not supported in X API v2:
Standard v1.1 parameterDetails
locations - A comma-separated list of longitude,latitude pairs specifying a set of bounding boxes to filter Posts by.We have not released location-based operators for X API v2 yet.
DelimitedWith the v1.1 endpoint, setting this to the string length indicates that statuses should be delimited in the stream, so that clients know how many bytes to read before the end of the status message.

This functionality is not available with X API v2.
Stall_warningsWith the v1.1 endpoint, setting this parameter to true will cause periodic messages to be delivered if the client is in danger of being disconnected. 

With X API v2, stall warnings are sent by default with the new line sent every so often.
Availability of recovery and redundancy features The X API v2 version of filtered stream introduces recovery and redundancy features that can help you maximize streaming up-time as well as recover any Posts that might have been missed due to a disconnection that lasted five minutes or less. Redundant connections allows you to connect to a given stream up to two times, which can help ensure that you maintain a connection to the stream at all times, even if one of your connections fails.  The backfill_minutes parameter can be used to recover up to five minutes of missed data.  Both of these features are only available via Academic Research access. You can learn more about this functionality via our recovery and redundancy features integration guide.  New query operators X API v2 introduces new operators in support of two new features: 
  • Conversation IDs - As conversations unfold on X, a conservation ID will be available to mark Posts that are part of the conversation. All Posts in the conversation will have their conversation_id set to the Post ID that started it. 
    • conversation_id:
  • X Annotations provide contextual information about Posts, and include entity and context annotations. Entities are comprised of people, places, products and organizations. Contexts are domains, or topics, that surfaced entities are a part of. For example, people mentioned in a Post may have a context that indicates whether they are an athlete, actor, or politician.  
    • context: - matches on Posts that have been annotated with a context of interest. 
    • entity: - matches on Posts that have been annotated with an entity of interest.