Skip to content

Commit a8d453a

Browse files
committed
Documentation edits made through Mintlify web editor
1 parent 851dece commit a8d453a

File tree

1 file changed

+71
-90
lines changed

1 file changed

+71
-90
lines changed

x-api/introduction.mdx

Lines changed: 71 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,87 @@
11
---
2-
title: Introduction
2+
title: "Introduction"
33
---
44

55
import { Button } from "/snippets/button.mdx"
66

77
The X API enables programmatic access to X in unique and advanced ways. Tap into core elements of X like: Posts, Direct Messages, Spaces, Lists, users, and more.
88

99
<div className="flex space-x-2.5">
10-
<Button href="https://developer.x.com/en/portal/products/pro">
11-
Subscribe to Pro access
12-
</Button>
10+
<Button href="https://developer.x.com/en/portal/products/pro">
11+
Subscribe to Pro access
12+
</Button>
13+
14+
<Button href="/x-api/getting-started/about-x-api">
15+
API access levels and versions
16+
</Button>
1317

14-
<Button href="/x-api/getting-started/about-x-api">
15-
API access levels and versions
16-
</Button>
1718
</div>
1819

19-
***
20+
---
2021

2122
## X API v2
2223

23-
X API v2 is ready for prime time! We recommend that the majority of developers start to think about migrating to v2 of the API, and for any new users to get started with v2. Why migrate?
24-
25-
<CardGroup cols={2}>
26-
<Card title="New and more detailed data objects" icon="database" href="/x-api/fundamentals/data-dictionary" />
24+
X API v2 is ready for prime time\! We recommend that the majority of developers start to think about migrating to v2 of the API, and for any new users to get started with v2. Why migrate?
2725

28-
<Card title="New parameters to request objects and fields" href="/x-api/fundamentals/data-dictionary#how-to-use-fields-and-expansions" icon="sliders" />
29-
30-
<Card title="Advanced metrics" href="/x-api/fundamentals/metrics" icon="chart-pie" />
31-
32-
<Card title="Receive and filter data with contextual post annotations" href="/x-api/fundamentals/post-annotations" icon="comment-dots" />
33-
34-
<Card title="Filter on and identify which posts belong to a reply thread" href="/x-api/fundamentals/conversation-id" icon="reply" />
35-
36-
<Card title="And much more..." href="/x-api/getting-started/about-x-api" icon="plus" />
26+
<CardGroup cols="2">
27+
<Card title="New and more detailed data objects" icon="database" href="/x-api/fundamentals/data-dictionary">
28+
29+
</Card>
30+
<Card title="New parameters to request objects and fields" icon="sliders" href="/x-api/fundamentals/data-dictionary#how-to-use-fields-and-expansions">
31+
32+
</Card>
33+
<Card title="Advanced metrics" icon="chart-pie" href="/x-api/fundamentals/metrics">
34+
35+
</Card>
36+
<Card title="Receive and filter data with contextual post annotations" icon="comment-dots" href="/x-api/fundamentals/post-annotations">
37+
38+
</Card>
39+
<Card title="Filter on and identify which posts belong to a reply thread" icon="reply" href="/x-api/fundamentals/conversation-id">
40+
41+
</Card>
42+
<Card title="And much more..." icon="plus" href="/x-api/getting-started/about-x-api">
43+
44+
</Card>
3745
</CardGroup>
3846

3947
## Access Levels
4048

4149
### Free
4250

43-
* For write-only use cases and testing the X API
44-
45-
* Low rate-limit access to v2 posts and media upload endpoints
46-
47-
* 1,500 Posts per month - posting limit at the app level
48-
49-
* 1 Project, 1 App per Project, 1 Environment
50-
51-
* Login with X, Access to Ads API
52-
53-
* Cost: Free
51+
- For write-only use cases and testing the X API
52+
- Low rate-limit access to v2 posts and media upload endpoints
53+
- 500 Posts per month - posting limit at the app level
54+
- 1 Project, 1 App per Project, 1 Environment
55+
- Login with X, Access to Ads API
56+
- Cost: Free
5457

5558
### Basic
5659

57-
* For hobbyists or prototypes
58-
59-
* Low-rate limit access to suite of v2 endpoints
60-
61-
* 3,000 Posts per month (user level), 50,000 Posts per month (app level)
62-
63-
* 10,000/month Posts read-limit rate cap
64-
65-
* 1 Project, 2 Apps per Project
66-
67-
* Login with X, Access to Ads API
68-
69-
* Cost: $200 per month
60+
- For hobbyists or prototypes
61+
- Low-rate limit access to suite of v2 endpoints
62+
- 3,000 Posts per month (user level), 50,000 Posts per month (app level)
63+
- 10,000/month Posts read-limit rate cap
64+
- 1 Project, 2 Apps per Project
65+
- Login with X, Access to Ads API
66+
- Cost: $200 per month
7067

7168
### Pro
7269

73-
* For startups scaling their business
74-
75-
* Rate-limited access to suite of v2 endpoints, including search and filtered stream
76-
77-
* 1,000,000 Posts per month - GET at the app level
78-
79-
* 300,000 Posts per month - posting limit at the app level
80-
81-
* 1 Project, 3 Apps per Project
82-
83-
* Login with X, Access to Ads API
84-
85-
* Cost: $5,000 per month
70+
- For startups scaling their business
71+
- Rate-limited access to suite of v2 endpoints, including search and filtered stream
72+
- 1,000,000 Posts per month - GET at the app level
73+
- 300,000 Posts per month - posting limit at the app level
74+
- 1 Project, 3 Apps per Project
75+
- Login with X, Access to Ads API
76+
- Cost: $5,000 per month
8677

8778
### Enterprise
8879

89-
* For businesses and scaled commercial projects
90-
91-
* Commercial-level access that meets your and your customer's specific needs
92-
93-
* Managed services by a dedicated account team
94-
95-
* Complete streams: replay, engagement metrics, backfill, and more features
96-
97-
* Cost: Monthly subscription tiers
80+
- For businesses and scaled commercial projects
81+
- Commercial-level access that meets your and your customer's specific needs
82+
- Managed services by a dedicated account team
83+
- Complete streams: replay, engagement metrics, backfill, and more features
84+
- Cost: Monthly subscription tiers
9885

9986
<Button href="/x-api/getting-started/about-x-api">
10087
More on v2 access levels
@@ -105,32 +92,28 @@ X API v2 is ready for prime time! We recommend that the majority of developers s
10592
Interested in migrating your current integration to X API v2? Check out our migration hub for resources that will help you understand what is different between v2 and previous versions, including the data formats. You can also access migration guides for each endpoint listed in the new v2 endpoint sections.
10693

10794
<div className="flex space-x-2.5">
108-
<Button href="/x-api/migrate/overview">
109-
Learn more
110-
</Button>
95+
<Button href="/x-api/migrate/overview">
96+
Learn more
97+
</Button>
98+
99+
<Button href="/x-api/migrate/x-api-endpoint-map">
100+
X API endpoint map
101+
</Button>
111102

112-
<Button href="/x-api/migrate/x-api-endpoint-map">
113-
X API endpoint map
114-
</Button>
115103
</div>
116104

117-
***
105+
---
118106

119107
## What to build
120108

121109
Check out our 'what to build" page to learn more about:
122110

123-
* Moderate conversations for health and safety
124-
125-
* Enable creation and personal expression
126-
127-
* Measure and analyze "what's happening"
128-
129-
* Improve community experiences
130-
131-
* Curate and recommend content
132-
133-
* Impact the greater good
111+
- Moderate conversations for health and safety
112+
- Enable creation and personal expression
113+
- Measure and analyze "what's happening"
114+
- Improve community experiences
115+
- Curate and recommend content
116+
- Impact the greater good
134117

135118
<Button href="/x-api/what-to-build">
136119
What to build
@@ -140,25 +123,23 @@ Check out our 'what to build" page to learn more about:
140123

141124
Go from zero to "Hello World" with the help of these resources, tools, and libraries.
142125

143-
<CardGroup cols={1}>
126+
<CardGroup cols="1">
144127
<Card title="Client libraries" icon="screwdriver-wrench">
145128
Check out our curated selection of all X-built and community-supported client libraries.
146129

147130
<br />
148131

149132
[Browse libraries](/x-api/tools-and-libraries/overview)
150133
</Card>
151-
152134
<Card title="v2 Postman collection" icon="book">
153-
We have built out a Postman collection for our v2 endpoints to help you explore the API using their visual client!
135+
We have built out a Postman collection for our v2 endpoints to help you explore the API using their visual client\!
154136

155137
<br />
156138

157139
[Get started with Postman](https://www.postman.com/xapidevelopers/twitter-s-public-workspace/collection/r90eid4/twitter-api-v2?ctx=documentation)
158140
</Card>
159-
160141
<Card title="Sample code" icon="code">
161-
Looking to get started building with the X API. We have sample code, clients, and other example apps available. Check out the @XDevelopers GitHub!
142+
Looking to get started building with the X API. We have sample code, clients, and other example apps available. Check out the @XDevelopers GitHub\!
162143

163144
<br />
164145

0 commit comments

Comments
 (0)