This API exposes
6 operations
across 6 paths,
and defines 61 schemas.
It is described by OpenAPI 3.2.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
X (Twitter) Spaces 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).
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
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.
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Get2SpacesIdTweetsResponse
object
4 properties
PaginationToken32
string
A base32 pagination token.
Media
object
4 properties
1 required
PreviousToken
string
The previous token.
NoteTweetText
string
The note content of the Tweet.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
SpaceId
string
The unique identifier of this Space.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
UserName
string
The X handle (screen name) of this user.
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
MediaKey
string
The Media Key identifier for this attachment.
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.
NextToken
string
The next token.
PollOptionLabel
string
The text of a poll choice.
Url
string
A validly formatted URL.
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
UrlImage
object
Represent the information for the URL image.
3 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties
1 required
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 properties
2 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
Geo
object
4 properties
3 required
Get2SpacesIdBuyersResponse
object
4 properties
User
object
The X User object.
21 properties
3 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
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 properties
2 required
Error
object
2 properties
2 required
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
TweetText
string
The content of the Tweet.
Expansions
object
6 properties
HttpStatusCode
integer
HTTP Status Code.
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
TopicId
string
Unique identifier of this Topic.
PollId
string
Unique identifier of this poll.
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
Get2SpacesIdResponse
object
3 properties
Tweet
object
29 properties
Get2SpacesByCreatorIdsResponse
object
4 properties
MediaWidth
integer
The width of the media in pixels.
CommunityId
string
The unique identifier of this Community.
MediaHeight
integer
The height of the media in pixels.
ResultCount
integer
The number of results returned in this response.
Space
object
17 properties
2 required
Place
object
8 properties
2 required
Get2SpacesSearchResponse
object
4 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
FullTextEntities
object
5 properties
PlaceId
string
The identifier for this place.
Get2SpacesResponse
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
