Projects

Overview

Projects allow you to organize your work based on how you intend to use the Twitter API, so you can effectively manage your access to the API and monitor your usage. Each Project can contain an App, with which you can generate authentication credentials (keys and tokens).

While you can use keys and tokens from any app to access the Twitter API, Twitter Ads API, or Labs, you must use keys and tokens from an App associated with a Project to be able to use the new Twitter API v2 endpoints. 

If you have a developer account, you can view and manage your Projects on the Projects & Apps page.
 

Product tracks and Projects

At this time, there are two different types of Projects that align with the Twitter API’s product track offering:

  • Standard Project
  • Academic Research Project
     

You will be able to unlock additional functionality and levels of access depending on which Project you are using. For example, if you are passing authentication credentials with your request that are associated with a Academic Research Project, you will have access to the full-archive search endpoint and be able to take advantage of advanced functionality when filtering results with the search Tweets and filtered stream endpoints. 

You can create a Standard Project via the developer portal dashboard with an approved developer account. 

To create an Academic Research Project, you must first apply and be approved to use the Academic Research product track. Your Academic Research Project will be created for you based on the details submitted in your application. Learn more about the Academic Research application here. Once you’ve been approved, you will have been provisioned an Academic Research Project based on the details that you submitted in your application. You can learn more via our Academic Research section.

Tweet caps and Projects

Tweet consumption caps apply at the Project-level, effectively limiting the volume of Tweets you can retrieve from certain Twitter API v2 endpoints within a given month.

Tweets received from the following endpoints count towards this monthly Tweet cap:

The Tweet cap volume depends on which product track you are using:

  • If you are using the Standard product track at the Basic access level, you will be limited to receiving 500,000 Tweets per month across the v2 endpoints noted earlier.
  • If you are using the Academic Research product track at the Basic access level, you will be limited to receiving 10,000,000 Tweets per month across v2 endpoints noted earlier. 

You can check your usage towards the monthly Tweet cap by viewing the main dashboard page. Under the name of your Project, you'll see a status bar that illustrates your current month’s usage in relation to the Tweet cap. You will also see the number of Tweets you pulled this month, the percentage of Tweets used in relation to the cap, and the date your Tweet cap usage resets.
 

This image shows what the Academic Research Project and usage dashboard looks like in the developer portal


Configuring Projects

Creating a Project

To create a Project, click on “New Project” in your dashboard or the Projects & Apps page within the developer portal. You’ll only be able to see this option if you haven’t already created a Project. You will be prompted to create a Project name, description, and use case. You will also be asked to create a new App or connect an existing standalone App.

If you are approved for the Academic Research product track, your Projects & Apps page will show the Academic Research Project and its details that you submitted with your application. To get started with Academic Research access, you will need to create or add an App to that Project. 

Creating or Connecting an App for your Project

If your Project doesn’t include an App, you can add one by clicking on the Project name in the dashboard. From there, you can either create a new App or select an existing standalone App to connect to your Project. The App is where you can generate your authentication keys and tokens, including the API Key and API Secret, Access Token and Access Token Secret, and Bearer Token.

Editing a Project

To edit a Project, click on the name of your Project from the dashboard or Projects & Apps page within the developer portal. From there you will see the details of your Project and can select “edit” to make changes. 
 

Standalone Apps

Standalone Apps are Apps that exist outside of the Project structure. The authentication credentials associated with these standalone Apps can make successful requests to Twitter API v1.1, Twitter API premium, Twitter Ads API, or Labs endpoints, but will fail when trying to make requests to the Twitter API v2 endpoints.

If you created an App before we announced the new Twitter API v2 in August 2020, they will be visible in the “Standalone Apps” section of the developer portal under Projects & Apps. You can have up to ten Apps in total, including those that are connected to your Project.

If you’re part of a team account, you will see the Apps that you own under Standalone Apps. If a teammate owns an App that’s part of a Project, you will be able to see the App’s name and owner’s info, but you will not be able to change its settings, access its keys and tokens, or regenerate its keys and tokens. You should contact the App owner to make any changes to their App.
 

Next steps

Was this document helpful?
Thank you

Thank you for the feedback. We’re really glad we could help!

Thank you for the feedback. How could we improve this document?
Thank you for the feedback. Your comments will help us improve our documents in the future.