Skip to main content
GET
X community notes contributor API for note counts
1 credit per lookup · All plans from $0.00012/credit · Supports guest paid reads

Who writes a Community Note?

X names each Community Notes contributor by an alias, never by their X account. Use GET /x/community-notes/contributors/{alias} to read 1 contributor’s record.
  • notesCount says how many notes they wrote, by X’s current rating.
  • ratingsCount says how their ratings of other notes went.
  • deletedNotesCount counts the notes they deleted.
Read what they wrote with contributor notes. Read what they deleted with deleted notes.

Path parameters

string
required
Contributor alias, such as ardent-beach-friarbird. The URL-encoded contributor URL also works, such as x.com/i/communitynotes/u/ardent-beach-friarbird. Any letter case works.

Query parameters

string
Fields to keep in each row, comma-separated, such as id,text,author.username. Use dots for nested fields. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name returns 400 unknown_field with the valid names, before any read. The price stays the same.
string
Fields to drop from each row, comma-separated, such as entities,media. It takes the same names as fields. With fields, it drops from the kept fields.

Headers

string
Full account key. Sessions and OAuth also work.
string
Bearer xq_your_guest_key_here for paid_reads.

Response

200 OK

X leaves out a field it does not send. Only alias is always present.
object
The contributor’s record.
string
The alias X gives the contributor.
boolean
Whether X marks the contributor as a top writer.
boolean
Whether the contributor writes notes through X’s API.
number
Notes the contributor deleted.
object
How many notes the contributor wrote, by X’s current rating. It holds awaitingMoreRatings, currentlyRatedHelpful, currentlyRatedNotHelpful & updatedAt.
object
How the contributor’s ratings of other notes went. It holds awaitingMoreRatings, ratedAfterDecision, successful, unsuccessful & updatedAt. successful counts the ratings that matched the rating X gave the note.

400 Invalid alias

The path named no contributor. This answer is free.

404 Contributor not found

No contributor holds the alias. This answer is free.

401 Unauthenticated

Anonymous requests get WWW-Authenticate: Bearer and a guest wallet checkout action. This is not a Payment challenge.

402 Payment required

Account keys get account options. Guest keys get guest top-up only. No checkout starts automatically. Confirm any payment action.

502 X API unavailable

The read service returned an error. Retry after a short delay.