Versioning

The endpoints we release in Labs will be previews and are likely to change before they are released broadly, so we encourage you to take that into consideration as you build. Before getting started, we encourage you to read more about Twitter Developer Labs.

Since Labs is an experimental program, the features and functionality of Labs products will likely evolve over time as we iterate development based on developer feedback. In some cases, changes made to Labs endpoints are not intended to be backward compatible. We will use versioning to avoid breaking changes to previously released versions and to allow for faster iteration. In such cases, we will plan to support prior versions for a period of time to allow for transitions to new versions. Versioning for Labs endpoints will be represented within the endpoint URI by a system of sequential version numbers containing a whole number for major revisions. 

For example:

https://api.twitter.com/labs/1/tweets

Breaking changes are those where a developer is expected to be forced to change their code. Examples of breaking changes include the following:

  • Removing a field from a response
  • Removing support for a query parameter
  • Adding a required parameter
  • Changing the type or semantic meaning of a field
     

Compatible changes are those that are not expected to break clients. Examples of compatible changes include the following:

  • Adding a field to a response
  • Adding support for an optional parameter
  • Making a field value null when it wasn't before, if the specification for the field marked it as nullable.
     

Compatible changes may be made within a major version, and may be made with or without notice. Client applications should be built to tolerate compatible changes without breaking. All breaking changes to Labs endpoints will be managed with a new version of the endpoint. Generally, we expect that two versions of an endpoint will be maintained for a period of time to allow developers time to migrate without disruption to their application.
 

Additional resources

  • Get started building with our quick start guides.
  • Check out our API reference to learn more about what’s available.
  • Give feedback on Twitter Developer Labs.
  • Tell us about your experience using the Twitter Developer Labs endpoints by filling out this survey.