You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: x-api/getting-started/about-x-api.mdx
+67-77Lines changed: 67 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: About the X API
2
+
title: "About the X API"
3
3
---
4
4
5
5
The X API can be used to programmatically retrieve and analyze X data, as well as build for the conversation on X.
@@ -11,110 +11,100 @@ Recently, we released the X API v2. The X API v2 includes a modern foundation, n
11
11
The following three tabs explain the different versions and access levels of the X API, what’s new with v2, and which X resources you can retrieve, create, destroy, and adjust using the API.
12
12
13
13
<Tabs>
14
+
<Tabtitle="Access levels and versions">
15
+
## X API access levels and versions
14
16
15
-
<Tabtitle="Access levels and versions">
17
+
While the X API v2 is the primary X API, the platform currently supports previous versions (v1.1, Gnip 2.0) as well. We recommend that all users start with v2 as this is where all future innovation will happen.
16
18
17
-
## X API access levels and versions
19
+
The X API v2 includes a few access levels:
18
20
19
-
While the X API v2 is the primary X API, the platform currently supports previous versions (v1.1, Gnip 2.0) as well. We recommend that all users start with v2 as this is where all future innovation will happen.
The X API v2 represents the largest upgrade of the X API since 2012. With it comes a host of new and advanced features, as well as fast and free access to the API.
Some of the features that are available with v2 include the following:
36
41
37
-
</Tab>
42
+
### New endpoints
38
43
39
-
<Tabtitle="What's new with v2">
44
+
We have released a set of net-new endpoints to X API v2. You can see a full list of v2 endpoints, including those that are new, on our X API endpoint map guide.
40
45
41
-
## What's new with v2
46
+
[Visit the X API endpoint map \>](/x-api/migrate/x-api-endpoint-map)
42
47
43
-
The X API v2 represents the largest upgrade of the X API since 2012. With it comes a host of new and advanced features, as well as fast and free access to the API.
48
+
### New and more detailed data objects
44
49
45
-
Some of the features that are available with v2 include the following:
50
+
We've modernized our data objects with a variety off new improvements that will enable you to more easily navigate and parse data.
46
51
47
-
### New endpoints
52
+
[Visit the data dictionary \>](/x-api/fundamentals/data-dictionary)
48
53
49
-
We have released a set of net-new endpoints to X API v2. You can see a full list of v2 endpoints, including those that are new, on our X API endpoint map guide.
54
+
### New parameters to help you retrieve just those objects and fields that you want
50
55
51
-
[Visit the X API endpoint map >](/x-api/migrate/x-api-endpoint-map)
56
+
We've added fields and expansions parameters to our data endpoints that allow you to request related objects and fields beyond those fields that return by default.
52
57
53
-
### New and more detailed data objects
58
+
[Learn how to use fields and expansions \>](/x-api/fundamentals/data-dictionary#how-to-use-fields-and-expansions)
54
59
55
-
We've modernized our data objects with a variety off new improvements that will enable you to more easily navigate and parse data.
60
+
### Advanced metrics
56
61
57
-
[Visit the data dictionary >](/x-api/fundamentals/data-dictionary)
62
+
More easily understand the performance of Posts, users, media, and polls from directly within your payload by requesting both public and private metrics including impressions, video views, user profile, and URL clicks, some of which are separated into an organic and promoted context.
58
63
59
-
### New parameters to help you retrieve just those objects and fields that you want
64
+
[Learn more about metrics \>](/x-api/fundamentals/metrics)
60
65
61
-
We've added fields and expansions parameters to our data endpoints that allow you to request related objects and fields beyond those fields that return by default.
66
+
### Filter on and identify which Posts contain different topics
62
67
63
-
[Learn how to use fields and expansions >](/x-api/fundamentals/data-dictionary#how-to-use-fields-and-expansions)
68
+
When using search Posts or filtered stream, you can now filter by topic using our entity and context operators. We've also provided these topics within the Post payload to help with analysis.
64
69
65
-
### Advanced metrics
70
+
[Learn more about Post annotations \>](/x-api/fundamentals/post-annotations)
66
71
67
-
More easily understand the performance of Posts, users, media, and polls from directly within your payload by requesting both public and private metrics including impressions, video views, user profile, and URL clicks, some of which are separated into an organic and promoted context.
72
+
### Filter on and identify which Posts belong to a reply thread
68
73
69
-
[Learn more about metrics >](/x-api/fundamentals/metrics)
74
+
Make it easier to identify a Post as part of a conversation thread when using search Posts, filtered stream, and Post lookup. We've also added the ability to determine whether conversation reply settings have been set for a Post with the Post field `reply_settings`.
70
75
71
-
### Filter on and identify which Posts contain different topics
76
+
[Learn more about conversation tracking \>](/x-api/fundamentals/conversation-id)
72
77
73
-
When using search Posts or filtered stream, you can now filter by topic using our entity and context operators. We've also provided these topics within the Post payload to help with analysis.
78
+
### And so much more...
74
79
75
-
[Learn more about Post annotations >](/x-api/fundamentals/post-annotations)
80
+
- High confidence spam filtering
81
+
- Shortened URLs are fully unwound for easier URL analysis
82
+
- Simplified JSON response objects by removing deprecated fields and modernizing labels
83
+
- Recovery and redundancy functionality for our streaming endpoints
84
+
- Return of 100% of matching public and available Posts in search queries
85
+
- Streaming "rules" so you can make changes without dropping connections
86
+
- More expressive query language for filtered stream and search
87
+
- OpenAPI spec to build new libraries & more transparently track changes
88
+
- API support for new features and endpoints more quickly as our platform evolves to meet the needs of developers, researchers, businesses, and people using X
89
+
</Tab>
90
+
<Tabtitle="X API resources">
91
+
## X API platform resources
76
92
77
-
### Filter on and identify which Posts belong to a reply thread
93
+
In the API design space, a resource is an entity with associated data, relationships to other resources, and a set of methods that operate on it. For example, a Post is a resource that you can create, delete, or retrieve using a variety of different tools, such as historically searching for them, or retrieving them in real-time.
78
94
79
-
Make it easier to identify a Post as part of a conversation thread when using search Posts, filtered stream, and Post lookup. We've also added the ability to determine whether conversation reply settings have been set for a Post with the Post field `reply_settings`.
80
-
81
-
[Learn more about conversation tracking >](/x-api/fundamentals/conversation-id)
82
-
83
-
### And so much more...
84
-
85
-
- High confidence spam filtering
86
-
- Shortened URLs are fully unwound for easier URL analysis
87
-
- Simplified JSON response objects by removing deprecated fields and modernizing labels
88
-
- Recovery and redundancy functionality for our streaming endpoints
89
-
- Return of 100% of matching public and available Posts in search queries
90
-
- Streaming "rules" so you can make changes without dropping connections
91
-
- More expressive query language for filtered stream and search
92
-
- OpenAPI spec to build new libraries & more transparently track changes
93
-
- API support for new features and endpoints more quickly as our platform evolves to meet the needs of developers, researchers, businesses, and people using X
94
-
95
-
</Tab>
96
-
97
-
<Tabtitle="X API resources">
98
-
99
-
## X API platform resources
100
-
101
-
In the API design space, a resource is an entity with associated data, relationships to other resources, and a set of methods that operate on it. For example, a Post is a resource that you can create, delete, or retrieve using a variety of different tools, such as historically searching for them, or retrieving them in real-time.
102
-
103
-
The X API provides access to create, delete, receive, or adjust a variety of different resources on the platform including the following:
104
-
105
-
| Resource | Description |
106
-
|:----------|:-------------|
107
-
|**Posts**| Tap into millions of Posts to understand the public conversation, or create your own to engage with the conversation.<br/><br/>Current availability:<br/>- X API v2<br/>- Enterprise<br/>- Standard v1.1 |
108
-
|**Users**| Manage or look up X users to analyze networks, understand your audience, or foster positive online relationships.<br/><br/>Current availability:<br/>- X API v2<br/>- Enterprise<br/>- Standard v1.1 |
109
-
|**Spaces**| Look up and search X Spaces and their attendees to help people find interesting and relevant audio conversations.<br/><br/>Current availability:<br/>- X API v2 |
110
-
|**Direct Messages**| Send and receive Direct Messages to triage customer issues, send welcome messages, or create positive human interaction.<br/><br/>Current availability:<br/>- Standard v1.1 |
111
-
|**Lists**| Curate and manage lists of accounts to keep a pulse on industry experts, powerful voices, or organize who you follow.<br/><br/>Current availability:<br/>- X API v2<br/>- Standard v1.1 |
112
-
|**Trends**| Identify geographic trends first to pinpoint industry movement, discover hot topics, or stay ahead of the latest fad.<br/><br/>Current availability:<br/>- Standard v1.1 |
113
-
|**Media**| Upload media objects to share your creative energy, create interactive experiences, or build accessibility tools.<br/><br/>Current availability:<br/>- Standard v1.1 |
114
-
|**Places**| Search for places to understand what's happening in your neighborhood and around the world.<br/><br/>Current availability:<br/>- Standard v1.1 |
115
-
116
-
</Tab>
95
+
The X API provides access to create, delete, receive, or adjust a variety of different resources on the platform including the following:
|**Posts**| Tap into millions of Posts to understand the public conversation, or create your own to engage with the conversation. Current availability: - X API v2 - Enterprise - Standard v1.1 |
100
+
|**Users**| Manage or look up X users to analyze networks, understand your audience, or foster positive online relationships. Current availability: - X API v2 - Enterprise - Standard v1.1 |
101
+
|**Spaces**| Look up and search X Spaces and their attendees to help people find interesting and relevant audio conversations. Current availability: - X API v2 |
102
+
|**Direct Messages**| Send and receive Direct Messages to triage customer issues, send welcome messages, or create positive human interaction. Current availability: - Standard v1.1 |
103
+
|**Lists**| Curate and manage lists of accounts to keep a pulse on industry experts, powerful voices, or organize who you follow. Current availability: - X API v2 - Standard v1.1 |
104
+
|**Trends**| Identify geographic trends first to pinpoint industry movement, discover hot topics, or stay ahead of the latest fad. Current availability: - Standard v1.1 |
105
+
|**Media**| Upload media objects to share your creative energy, create interactive experiences, or build accessibility tools. Current availability: - Standard v1.1 |
106
+
|**Places**| Search for places to understand what's happening in your neighborhood and around the world. Current availability: - Standard v1.1 |
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?v=4&size=40){kind=avatar}
0 commit comments