X (Twitter) Activity API is one of 23 APIs that X (Twitter) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Activity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.
This API exposes
6 operations
across 3 paths,
and defines 43 schemas.
It is described by OpenAPI 3.0.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
6 operations3 paths43 schemas2 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
X (Twitter) Activity API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes.
It uses HTTP oauth authentication (UserToken).
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 2 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are User (21 properties), UrlFields (9 properties), ActivitySubscription (7 properties), FullTextEntities (5 properties). Each schema is shown below with its type and property counts.
WebhookConfigId
string
The unique identifier of this webhook config.
UrlImage
object
Represent the information for the URL image.
3 properties
ActivitySubscriptionId
string
The unique identifier of this subscription.
ActivityEventId
string
The unique identifier of an Activity event.
ActivityStreamingResponse
object
An activity event or error that can be returned by the x activity streaming API.
2 properties
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
UserName
string
The X handle (screen name) of this user.
FollowActivityResponsePayload
object
2 properties
ActivitySubscriptionGetResponse
object
3 properties
HttpStatusCode
integer
HTTP Status Code.
ActivitySubscriptionFilter
object
An XAA subscription filter.
3 properties
ActivitySubscriptionDeleteResponse
object
3 properties
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties2 required
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties1 required
HashtagEntity
ProfileUpdateActivityResponsePayload
object
2 properties
ActivitySubscriptionUpdateRequest
object
2 properties
ActivityStreamingResponsePayload
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property1 required
MediaKey
string
The Media Key identifier for this attachment.
Error
object
2 properties2 required
ActivitySubscriptionCreateRequest
object
4 properties2 required
MediaHeight
integer
The height of the media in pixels.
ActivitySubscriptionUpdateResponse
object
1 property
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property1 required
Keyword
string
A keyword to filter on.
User
object
The X User object.
21 properties3 required
MentionEntity
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties1 required
FullTextEntities
object
5 properties
ActivitySubscriptionCreateResponse
object
3 properties
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties1 required
ActivitySubscription
object
An XActivity subscription.
7 properties5 required
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties2 required
CashtagEntity
PaginationToken32
string
A base32 pagination token.
NewsActivityResponsePayload
object
4 properties
Url
string
A validly formatted URL.
MediaWidth
integer
The width of the media in pixels.
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
