Skip to content

Commit b702cd8

Browse files
committed
Add pay-per-usage docs
1 parent 646a7cb commit b702cd8

File tree

198 files changed

+19921
-10561
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

198 files changed

+19921
-10561
lines changed

changelog.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Today, we’re launching improvements to the [reposts lookup](https://developer.
251251

252252
<Update label="Dec 14, 2021" description="X API v2: Authentication" >
253253
### Support for OAuth 2.0 Authentication
254-
Today, all developers can now authenticate using OAuth 2.0 by selecting OAuth 2.0 as an authentication method in the developer portal. We’ve added support for confidential and public clients and all relevant v2 endpoints to use this authentication method as part of this release.
254+
Today, all developers can now authenticate using OAuth 2.0 by selecting OAuth 2.0 as an authentication method in the Developer Console. We’ve added support for confidential and public clients and all relevant v2 endpoints to use this authentication method as part of this release.
255255

256256
OAuth 2.0 is an industry-standard authorization protocol that provides developers more control over an application’s scopes and improves authorization flows across multiple devices. In other words, developers building applications for people on X will have more control over the information their App requests from its users, so that you only have to ask your end-users for the data and information you need.
257257

@@ -407,7 +407,7 @@ Today, we’re launching the new [post counts endpoints](/x-api/posts/counts/int
407407

408408
<Update label="Jun 21, 2021" description="Improvements to Teams Functionality" >
409409
### Improvements to Teams
410-
Today, we’re launching key improvements to the functionality of teams based on feedback we’ve heard from the community. We have updated the style and design of the team page. We also made changes to the invitation flow to make it easier to invite team members or to learn more about why an invitation might have failed. If you have a team account you can check out the changes by viewing the [teams page](https://developer.x.com/en/portal/teams) of the developer portal. To learn more about teams check out our [documentation on the subject](https://developer.x.com/en/docs/developer-portal/overview#team) and related [FAQ](https://developer.x.com/en/docs/developer-portal/faq#dev-portal-management-faq).
410+
Today, we’re launching key improvements to the functionality of teams based on feedback we’ve heard from the community. We have updated the style and design of the team page. We also made changes to the invitation flow to make it easier to invite team members or to learn more about why an invitation might have failed. If you have a team account you can check out the changes by viewing the [teams page](https://developer.x.com/en/portal/teams) of the Developer Console. To learn more about teams check out our [documentation on the subject](https://developer.x.com/en/docs/Developer Console/overview#team) and related [FAQ](https://developer.x.com/en/docs/Developer Console/faq#dev-portal-management-faq).
411411

412412
To learn more about this launch, please visit our [forum announcement](https://devcommunity.x.com/t/announcing-improvements-to-the-functionality-of-teams/155447/2).
413413
</Update>
@@ -463,13 +463,13 @@ Today, we’re launching the new [manage follows](/x-api/users/follows) endpoint
463463

464464
<Update label="Jan 26, 2021" description="Introducing the X API v2 Academic Research product track" >
465465
### Introduction of Academic Research Product Track
466-
Today, we are introducing the new [Academic Research product track](/resources/fundamentals/projects) to [X API v2](/x-api/introduction). This update introduces a new application process for Academic Researchers that will provide those that are approved with an Academic Research [Project](/resources/fundamentals/projects) that will unlock greater access and advanced functionality.
466+
Today, we are introducing the new [Academic Research product track](/resources/fundamentals/developer-apps) to [X API v2](/x-api/introduction). This update introduces a new application process for Academic Researchers that will provide those that are approved with an Academic Research [Project](/resources/fundamentals/developer-apps) that will unlock greater access and advanced functionality.
467467

468468
With the new Academic Research product track, you will be able to access the following:
469469

470470
* The new X API v2 [full-archive search endpoint](/x-api/posts/full-archive-search), which is only available to the Academic Research product track at this time.
471471

472-
* An increased [post cap](/x-api/fundamentals/post-cap) of 10 million, up from the 500,000 that is available to the [Standard product track](/resources/fundamentals/projects) at the Basic [access level](https://developer.x.com/en/products/x-api/early-access/guide#na_2).
472+
* An increased [post cap](/x-api/fundamentals/post-cap) of 10 million, up from the 500,000 that is available to the [Standard product track](/resources/fundamentals/developer-apps) at the Basic [access level](https://developer.x.com/en/products/x-api/early-access/guide#na_2).
473473

474474
* New filter operators available to [recent search](/x-api/posts/recent-search), [full-archive search](/x-api/posts/full-archive-search), and [filtered stream](/x-api/posts/filtered-stream), including `$` (aka cashtag), `bio` (only available via filtered stream), `bio_name` (only available via filtered stream), `bio_location` (only available via filtered stream), `place`, `place_country`, `point_radius`, `bounding_box`, `-is:nullcast`, `has:cashtags` and `has:geo`.
475475

@@ -529,11 +529,11 @@ On August 12th, 2020, we launched the new X API v2: Early access. With this rele
529529
If you have any questions, please reach out to our [Labs forum category](https://devcommunity.x.com/c/labs/57).
530530
</Update>
531531

532-
<Update label="Sep 3, 2020" description="post consumption status bar added to the new developer portal experience" >
532+
<Update label="Sep 3, 2020" description="post consumption status bar added to the new Developer Console experience" >
533533
### Addition of Post Consumption Status Bar
534-
In the [main dashboard page](https://developer.x.com/en/portal/dashboard) of the new developer portal, you can now check your usage towards the [post cap](/x-api/fundamentals/post-cap) of 500,000 posts per month. This cap is applied at the Project level, across the following v2 endpoints in Basic access: filtered stream, and recent search.
534+
In the [main dashboard page](https://developer.x.com/en/portal/dashboard) of the new Developer Console, you can now check your usage towards the [post cap](/x-api/fundamentals/post-cap) of 500,000 posts per month. This cap is applied at the Project level, across the following v2 endpoints in Basic access: filtered stream, and recent search.
535535

536-
In order to see this feature and use the new v2 endpoints, you will need to activate the [new developer portal experience](https://developer.x.com/en/portal/opt-in.html).
536+
In order to see this feature and use the new v2 endpoints, you will need to activate the [new Developer Console experience](https://developer.x.com/en/portal/opt-in.html).
537537
</Update>
538538

539539
<Update label="Aug 19, 2020" description="Hide replies available in v2 X API" >
@@ -911,7 +911,7 @@ Today, we are introducing a new operator, is:reply, to help you narrow conversat
911911
</Update>
912912

913913
<Update label="Nov 19, 2018" description="X API: Standard v1.1" >
914-
### Access to Apps in Developer Portal
914+
### Access to Apps in Developer Console
915915
Today, we've added the ability for developers to view and edit their existing [X apps](/resources/fundamentals/developer-apps) via the [X app dashboard](https://developer.x.com/content/developer-twitter/en/apps) on developer.x.com as long as they're logged into their X account. Previously, you could only view and edit your existing X apps on developer.x.com if you had applied or been approved for a [developer account](/resources/fundamentals/developer-portal).
916916

917917
You still must have an approved developer account to be able to create new X apps.
@@ -1020,7 +1020,7 @@ The [Account Activity API DM Beta](/x-api/enterprise-gnip-2.0/fundamentals/accou
10201020

10211021
<Update label="Jul 24, 2018" description="X API: Standard v1.1" >
10221022
### Changes to App Creation and Rate Limits
1023-
As of today, you will no longer be able to create new [X apps](/resources/fundamentals/developer-apps) via [apps.x.com](https://apps.x.com/). You will now be redirected to either your [developer portal](/resources/fundamentals/developer-portal) account or, if you don't have a developer portal account yet, to the page where [you can apply](https://developer.x.com/content/developer-twitter/en/apply-for-access).
1023+
As of today, you will no longer be able to create new [X apps](/resources/fundamentals/developer-apps) via [apps.x.com](https://apps.x.com/). You will now be redirected to either your [Developer Console](/resources/fundamentals/developer-portal) account or, if you don't have a Developer Console account yet, to the page where [you can apply](https://developer.x.com/content/developer-twitter/en/apply-for-access).
10241024

10251025
We also announced that we will be implementing new app-level rate limits to the following POST endpoints on September 10th, 2018.
10261026

@@ -1040,8 +1040,8 @@ As of today, you will no longer be able to create new [X apps](/resources/fundam
10401040
</Update>
10411041

10421042
<Update label="Jun 21, 2018" description="X API: Standard v1.1" >
1043-
### App Management in Developer Portal
1044-
If you have a [developer portal](/resources/fundamentals/developer-portal) account, you can now create and manage your [X apps](/resources/fundamentals/developer-apps). Please read our [forum post](https://devcommunity.x.com/t/app-creation-and-management-now-available-in-the-developer-portal/107723) for more details.
1043+
### App Management in Developer Console
1044+
If you have a [Developer Console](/resources/fundamentals/developer-portal) account, you can now create and manage your [X apps](/resources/fundamentals/developer-apps). Please read our [forum post](https://devcommunity.x.com/t/app-creation-and-management-now-available-in-the-Developer Console/107723) for more details.
10451045
</Update>
10461046

10471047
<Update label="Jun 12, 2018" description="X API: Standard v1.1" >

developer-terms/agreement.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ In this Agreement, the following definitions apply:
9393

9494
**J. Access Tiers.** X provides different tiers of access (as described at [developer.x.com/en](http://developer.x.com/en)) to the Licensed Material, and you shall subscribe to the tier that best fits your use case. X may, at any time, review your use of its Licensed Materials and require a change in the access tier to which you are subscribed, including but not limited to, application for Enterprise access (as described at [developer.x.com/en](http://developer.x.com/en)).
9595

96-
**K. Prohibition on I-Framing:** You shall not, under any circumstances, embed, display, or otherwise incorporate any Licensed Material, X Content, X API, or elements of the X Applications within an iframe, inline frame, or any similar embedding mechanism on your Services or any other platform. This prohibition is absolute and includes, but is not limited to, attempts to frame X Content for display, integration, or redistribution purposes. Violation of this clause may result in immediate termination of your Developer Agreement and your access to the Licensed Material (e.g., X API, X Data License, Developer Portal) as outlined in Section VII.I.
96+
**K. Prohibition on I-Framing:** You shall not, under any circumstances, embed, display, or otherwise incorporate any Licensed Material, X Content, X API, or elements of the X Applications within an iframe, inline frame, or any similar embedding mechanism on your Services or any other platform. This prohibition is absolute and includes, but is not limited to, attempts to frame X Content for display, integration, or redistribution purposes. Violation of this clause may result in immediate termination of your Developer Agreement and your access to the Licensed Material (e.g., X API, X Data License, Developer Console) as outlined in Section VII.I.
9797

9898
**IV. Updates and Removals.**
9999

developer-terms/ppu-pilot-agreement.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ In this Agreement, the following definitions apply:
9595

9696
**J. Usage Levels Under Agreement.** X may, at any time, review your use of its Licensed Materials under this Agreement, and suspend or terminate your use and require you to file an application for Enterprise access (as described at [**developer.x.com/en**](http://developer.x.com/en)) in order for X to consider your proposed continued use of Licensed Materials.
9797

98-
**K. Prohibition on I-Framing:** You shall not, under any circumstances, embed, display, or otherwise incorporate any Licensed Material, X Content, X API, or elements of the X Applications within an iframe, inline frame, or any similar embedding mechanism on your Services or any other platform. This prohibition is absolute and includes, but is not limited to, attempts to frame X Content for display, integration, or redistribution purposes. Violation of this clause may result in immediate termination of your Developer Agreement and your access to the Licensed Material (e.g., X API, X Data License, Developer Portal) as outlined in Section VII.I.
98+
**K. Prohibition on I-Framing:** You shall not, under any circumstances, embed, display, or otherwise incorporate any Licensed Material, X Content, X API, or elements of the X Applications within an iframe, inline frame, or any similar embedding mechanism on your Services or any other platform. This prohibition is absolute and includes, but is not limited to, attempts to frame X Content for display, integration, or redistribution purposes. Violation of this clause may result in immediate termination of your Developer Agreement and your access to the Licensed Material (e.g., X API, X Data License, Developer Console) as outlined in Section VII.I.
9999

100100
**IV. Updates and Removals.**
101101

docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
"group": "Fundamentals",
2727
"pages": [
2828
"fundamentals/developer-apps",
29-
"fundamentals/projects",
3029
"fundamentals/developer-portal",
3130
{
3231
"group": "Authentication",
@@ -113,6 +112,7 @@
113112
"group": "Getting started",
114113
"pages": [
115114
"x-api/getting-started/about-x-api",
115+
"x-api/getting-started/pricing",
116116
"x-api/getting-started/getting-access",
117117
"x-api/getting-started/make-your-first-request",
118118
"x-api/getting-started/important-resources"
@@ -1938,7 +1938,7 @@
19381938
"global": {
19391939
"anchors": [
19401940
{
1941-
"anchor": "Developer Portal",
1941+
"anchor": "Developer Console",
19421942
"href": "https://developer.x.com/en/portal/petition/essential/basic-info",
19431943
"icon": "circle-play"
19441944
},
@@ -1977,7 +1977,7 @@
19771977
],
19781978
"primary": {
19791979
"type": "button",
1980-
"label": "Developer portal",
1980+
"label": "Developer Console",
19811981
"href": "https://developer.x.com/en/portal/petition/essential/basic-info"
19821982
}
19831983
},

fundamentals/authentication/guides/authentication-best-practices.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The following sections include best practices that should be considered when man
1616

1717
In the event that you believe that your API keys has been exposed, you should regenerate your API keys by following these steps:
1818

19-
1. Navigate to the [developer portal's "Projects and Apps" page](https://developer.x.com/en/portal/projects-and-apps.html).
19+
1. Navigate to the [Developer Console's "Apps" page](https://developer.x.com/en/portal/projects-and-apps.html).
2020
2. Click on the "Keys and tokens" icon (🗝 ) next to the relevant App.
2121
3. Click on the "Regenerate" button next to the set of keys and tokens that you would like to regenerate. 
2222

fundamentals/authentication/guides/log-in-with-x.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The three steps for implementing Log in with X through obtaining a request token
3636
To start a sign-in flow, your [X app](/resources/fundamentals/developer-apps) must obtain a request token by sending a signed message to [POST oauth/request_token](/resources/fundamentals/authentication/api-reference#post-oauth-request-token). The only unique parameter in this request is oauth_callback, which must be a URL-encoded version of the URL you wish your user to be redirected to when they complete step 2. The remaining parameters are added by the OAuth signing process.
3737

3838
<Note>
39-
**Note:** Any [callback URL](/resources/fundamentals/developer-apps#callback-urls) that you use with the [POST oauth/request_token](/resources/fundamentals/authentication/api-reference#post-oauth-request-token) endpoint will have to be registered within the [X app settings](/resources/fundamentals/developer-apps) in the [developer portal](/resources/fundamentals/developer-portal).
39+
**Note:** Any [callback URL](/resources/fundamentals/developer-apps#callback-urls) that you use with the [POST oauth/request_token](/resources/fundamentals/authentication/api-reference#post-oauth-request-token) endpoint will have to be registered within the [X app settings](/resources/fundamentals/developer-apps) in the [Developer Console](/resources/fundamentals/developer-portal).
4040
</Note>
4141

4242
<Frame>

fundamentals/authentication/oauth-1-0a/api-key-and-secret.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These credentials can be used by [authentication endpoints](/resources/fundament
1717
To acquire a X API Key and Secret, please follow these steps:
1818

1919
1. [Sign up for a X developer account](https://developer.x.com/en/apply-for-access)
20-
2. Create a [X App](/resources/fundamentals/developer-apps) within the [developer portal](/resources/fundamentals/developer-portal). Note that if you would like to use [X API v2](/x-api/introduction), you must add your X App to a [Project](/resources/fundamentals/projects).
20+
2. Create a [X App](/resources/fundamentals/developer-apps) within the [Developer Console](/resources/fundamentals/developer-portal). Note that if you would like to use [X API v2](/x-api/introduction), you must use keys and tokens from a developer App.
2121

2222

2323
When you create your X App, you will be presented with your API Key and Secret, along with a Bearer Token. Please note that we only display these credentials once, so make sure to save them in your password manager or somewhere secure.
@@ -29,8 +29,8 @@ We have more recommendations on how to handle your keys and tokens within our [a
2929

3030
If you've already created an App and need to find or regenerate your API Key and Secret, please follow these steps:
3131

32-
1. Navigate to the developer portal
33-
2. Expand the 'Projects and Apps' dropdown in the sidenav
32+
1. Navigate to the Developer Console
33+
2. Expand the 'Apps' dropdown in the sidenav
3434
3. Open the App which is associated with the API Key and Secret that you would like to find or regenerate
3535
4. Navigate to the Keys and tokens tab
3636

fundamentals/authentication/oauth-1-0a/authorizing-a-request.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You should be able to see that the header contains 7 key/value pairs, where the
6060

6161
**Consumer key**
6262

63-
The oauth\_consumer\_key identifies which application is making the request. Obtain this value from the settings page for your [X app](/resources/fundamentals/developer-apps) in the [developer portal](/resources/fundamentals/developer-portal).
63+
The oauth\_consumer\_key identifies which application is making the request. Obtain this value from the settings page for your [X app](/resources/fundamentals/developer-apps) in the [Developer Console](/resources/fundamentals/developer-portal).
6464

6565
| | |
6666
| :--- | :--- |
@@ -104,7 +104,7 @@ The oauth_timestamp parameter indicates when the request was created. This val
104104

105105
The oauth_token parameter typically represents a user’s permission to share access to their account with your application. There are a few authentication requests where this value is not passed or is a different form of token, but those are covered in detail in [Obtaining access tokens](/resources/fundamentals/authentication/oauth-1-0a/obtaining-user-access-tokens). For most general-purpose requests, you will use what is referred to as an **access token**.
106106

107-
You can generate a valid [access token](/resources/fundamentals/authentication/oauth-1-0a/obtaining-user-access-tokens) for your account on the settings page for your [X app](/resources/fundamentals/developer-apps) on the [developer portal](/resources/fundamentals/developer-portal).
107+
You can generate a valid [access token](/resources/fundamentals/authentication/oauth-1-0a/obtaining-user-access-tokens) for your account on the settings page for your [X app](/resources/fundamentals/developer-apps) on the [Developer Console](/resources/fundamentals/developer-portal).
108108

109109
| | |
110110
| :--- | :--- |

0 commit comments

Comments
 (0)