X (Twitter) Community Notes 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 Community Notes. 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
5 operations
across 5 paths,
and defines 68 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.
The identity and technical contract details declared by the specification.
MisleadingTags
string
Community Note misleading tags type.
NoteTweetText
string
The note content of the Tweet.
PollId
string
Unique identifier of this poll.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Media
object
4 properties
1 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
UrlImage
object
Represent the information for the URL image.
3 properties
Geo
object
4 properties
3 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
NoteTestResult
object
The evaluation result of a community note.
2 properties
Get2NotesSearchNotesWrittenResponse
object
3 properties
EvaluateNoteRequest
object
2 properties
2 required
UserName
string
The X handle (screen name) of this user.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
PlaceId
string
The identifier for this place.
NextToken
string
The next token.
NoteScoringStatus
object
The scoring status of a Community Note.
2 properties
HttpStatusCode
integer
HTTP Status Code.
PollOptionLabel
string
The text of a poll choice.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 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
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
NoteRatingStatus
string
Community Note rating status
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
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.
Note
object
A X Community Note is a note on a Post.
6 properties
3 required
MediaKey
string
The Media Key identifier for this attachment.
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
CommunityId
string
The unique identifier of this Community.
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
NoteFactorBucketCounts
object
Rating counts for a rater factor bucket.
5 properties
Error
object
2 properties
2 required
MediaHeight
integer
The height 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.
Place
object
8 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
EvaluateNoteResponse
object
2 properties
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…
CreateNoteRequest
object
3 properties
3 required
User
object
The X User object.
21 properties
3 required
ResultCount
integer
The number of results returned in this response.
NoteId
string
The unique identifier of this Community Note.
FullTextEntities
object
5 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 properties
1 required
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
Tweet
object
29 properties
TopicId
string
Unique identifier of this Topic.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
NoteClassification
string
Community Note classification type.
DeleteNoteResponse
object
2 properties
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
NoteInfo
object
A X Community Note is a note on a Post.
4 properties
4 required
Url
string
A validly formatted URL.
Expansions
object
6 properties
TweetText
string
The content of the Tweet.
Get2NotesSearchPostsEligibleForNotesResponse
object
4 properties
MediaWidth
integer
The width of the media in pixels.
NoteRatingCountsPerModel
object
The rating counts of a Community Note per model.
3 properties
CreateNoteResponse
object
2 properties
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X (Twitter) publishes across the network.
