> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xquik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Community notes contributor, X (Twitter) API docs

> Get a Community Notes contributor by alias, with note counts by rating, rating counts, and the deleted notes count. 1 credit per lookup, unknown aliases free.

> For the complete documentation index, see [llms.txt](https://docs.xquik.com/llms.txt).

`GET https://xquik.com/api/v1/x/community-notes/contributors/{alias}`

**1 credit per lookup** · [All plans](https://xquik.com) from \$0.00012/credit · Supports [guest paid reads](https://docs.xquik.com/guides/guest-wallets.md)

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/bash.json","/languages/csharp.json","/languages/go.json","/languages/java.json","/languages/javascript.json","/languages/kotlin.json","/languages/php.json","/languages/python.json","/languages/ruby.json","/languages/typescript.json"]}}
curl "https://xquik.com/api/v1/x/community-notes/contributors/ardent-beach-friarbird" \
  -H "x-api-key: xq_your_api_key_here" | jq
```

```javascript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/bash.json","/languages/csharp.json","/languages/go.json","/languages/java.json","/languages/javascript.json","/languages/kotlin.json","/languages/php.json","/languages/python.json","/languages/ruby.json","/languages/typescript.json"]}}
const alias = "ardent-beach-friarbird";
const response = await fetch(`https://xquik.com/api/v1/x/community-notes/contributors/${alias}`, {
  headers: { "x-api-key": "xq_your_api_key_here" },
});
const body = await response.json();
if (!response.ok) throw new Error(JSON.stringify(body));

const { notesCount, ratingsCount } = body.contributor;
console.log(`${notesCount.currentlyRatedHelpful} notes rated helpful`);
console.log(`${ratingsCount.successful.total} ratings matched the final rating`);
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/bash.json","/languages/csharp.json","/languages/go.json","/languages/java.json","/languages/javascript.json","/languages/kotlin.json","/languages/php.json","/languages/python.json","/languages/ruby.json","/languages/typescript.json"]}}
import requests

alias = "ardent-beach-friarbird"
response = requests.get(
    f"https://xquik.com/api/v1/x/community-notes/contributors/{alias}",
    headers={"x-api-key": "xq_your_api_key_here"},
)
body = response.json()
if not response.ok:
    raise RuntimeError(body)

contributor = body["contributor"]
print(contributor["notesCount"]["currentlyRatedHelpful"], "notes rated helpful")
print(contributor["ratingsCount"]["successful"]["total"], "ratings matched the final rating")
```

## 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](https://docs.xquik.com/api-reference/x/community-notes-contributor-notes.md). Read what they
deleted with [deleted notes](https://docs.xquik.com/api-reference/x/community-notes-contributor-deleted-notes.md).

## Path parameters

| Path parameter | Type | Required | Description |
| - | - | - | - |
| `alias` | `string` | Yes | 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

| Query parameter | Type | Required | Description |
| - | - | - | - |
| `fields` | `string` | No | 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. |
| `omit` | `string` | No | 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

| Header | Type | Required | Description |
| - | - | - | - |
| `x-api-key` | `string` | No | Full account key. Sessions and OAuth also work. |
| `Authorization` | `string` | No | `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.

| Field | Type | Description |
| - | - | - |
| `contributor` | `object` | The contributor's record. |
| `contributor.alias` | `string` | The alias X gives the contributor. |
| `contributor.isTopWriter` | `boolean` | Whether X marks the contributor as a top writer. |
| `contributor.isApiContributor` | `boolean` | Whether the contributor writes notes through X's API. |
| `contributor.deletedNotesCount` | `number` | Notes the contributor deleted. |
| `contributor.notesCount` | `object` | How many notes the contributor wrote, by X's current rating. It holds `awaitingMoreRatings`, `currentlyRatedHelpful`, `currentlyRatedNotHelpful` & `updatedAt`. |
| `contributor.ratingsCount` | `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.

> [!NOTE]
>
> **Related.** [Contributor notes](https://docs.xquik.com/api-reference/x/community-notes-contributor-notes.md) · [Deleted notes](https://docs.xquik.com/api-reference/x/community-notes-contributor-deleted-notes.md) · [Get tweet](https://docs.xquik.com/api-reference/x/get-tweet.md)

> [accordion] Related tweet, reply & media APIs
>
> * Tweets
>   * [Get tweet](https://docs.xquik.com/api-reference/x/get-tweet.md)
>   * [Tweet insights](https://docs.xquik.com/api-reference/x/tweet-engagement-insights.md)
>   * [Batch tweets](https://docs.xquik.com/api-reference/x/batch-tweets.md)
>   * [Tweet thread](https://docs.xquik.com/api-reference/x/tweet-thread.md)
>   * [Hidden replies](https://docs.xquik.com/api-reference/x/tweet-hidden-replies.md)
>   * [Translate tweet](https://docs.xquik.com/api-reference/x/tweet-translation.md)
>   * [Embed tweet](https://docs.xquik.com/api-reference/x/tweet-embed.md)
>   * [Resolve links](https://docs.xquik.com/api-reference/x/resolve-links.md)
>   * [Tweet subtitles](https://docs.xquik.com/api-reference/x/tweet-subtitles.md)
>   * [X Article](https://docs.xquik.com/api-reference/x/get-article.md)
> * Analysis
>   * [Sentiment analysis](https://docs.xquik.com/api-reference/x/sentiment-analysis.md)
>   * [Brand mentions](https://docs.xquik.com/api-reference/x/brand-monitoring.md)
>   * [News classification](https://docs.xquik.com/api-reference/x/news-classification.md)
>   * [Market signals](https://docs.xquik.com/api-reference/x/market-signals.md)
>   * [Viral score](https://docs.xquik.com/api-reference/x/viral-score.md)
>   * [Classify posts](https://docs.xquik.com/api-reference/x/classify-tweets.md)
> * Engagement
>   * [Tweet replies](https://docs.xquik.com/api-reference/x/tweet-replies.md)
>   * [Quote tweets](https://docs.xquik.com/api-reference/x/tweet-quotes.md)
>   * [Likers](https://docs.xquik.com/api-reference/x/favoriters.md)
>   * [Reposters](https://docs.xquik.com/api-reference/x/retweeters.md)
>   * [Reposter IDs](https://docs.xquik.com/api-reference/x/retweeter-ids.md)
>   * [Check repost](https://docs.xquik.com/api-reference/x/tweet-repost-check.md)
> * Profiles
>   * [User tweets](https://docs.xquik.com/api-reference/x/user-tweets.md)
>   * [Batch user tweets](https://docs.xquik.com/api-reference/x/batch-user-tweets.md)
>   * [User replies](https://docs.xquik.com/api-reference/x/user-replies.md)
>   * [User likes](https://docs.xquik.com/api-reference/x/user-likes.md)
>   * [User media](https://docs.xquik.com/api-reference/x/user-media.md)
>   * [User highlights](https://docs.xquik.com/api-reference/x/user-highlights.md)
>   * [User articles](https://docs.xquik.com/api-reference/x/user-articles.md)
> * Feeds
>   * [List tweets](https://docs.xquik.com/api-reference/x/list-tweets.md)
>   * [Trends](https://docs.xquik.com/api-reference/x/trends.md)
>   * [Trends history](https://docs.xquik.com/api-reference/x/trends-history.md)
>   * [Top tweets](https://docs.xquik.com/api-reference/x/top-tweets.md)
>   * [Trend locations](https://docs.xquik.com/api-reference/x/trend-locations.md)
>   * [Search Spaces](https://docs.xquik.com/api-reference/x/search-spaces.md)
>   * [Get Space](https://docs.xquik.com/api-reference/x/get-space.md)
>   * [Space replay](https://docs.xquik.com/api-reference/x/space-replay.md)
>   * [Get broadcast](https://docs.xquik.com/api-reference/x/get-broadcast.md)
>   * [User live status](https://docs.xquik.com/api-reference/x/user-live-status.md)
>   * [User shadowban](https://docs.xquik.com/api-reference/x/user-shadowban.md)
>   * [Notes contributor](https://docs.xquik.com/api-reference/x/community-notes-contributor.md)
>   * [Contributor notes](https://docs.xquik.com/api-reference/x/community-notes-contributor-notes.md)
>   * [Deleted notes](https://docs.xquik.com/api-reference/x/community-notes-contributor-deleted-notes.md)
>   * [Hashflags](https://docs.xquik.com/api-reference/x/hashflags.md)
>   * [Search places](https://docs.xquik.com/api-reference/x/search-places.md)
>   * [Download media](https://docs.xquik.com/api-reference/x/download-media.md)

## Response examples

### 200 example

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/bash.json","/languages/csharp.json","/languages/go.json","/languages/java.json","/languages/javascript.json","/languages/kotlin.json","/languages/php.json","/languages/python.json","/languages/ruby.json","/languages/typescript.json"]}}
{
  "contributor": {
    "alias": "ardent-beach-friarbird",
    "deletedNotesCount": 0,
    "isApiContributor": false,
    "isTopWriter": false,
    "notesCount": {
      "awaitingMoreRatings": 18,
      "currentlyRatedHelpful": 1,
      "currentlyRatedNotHelpful": 2,
      "updatedAt": "2026-10-12T22:18:40.096Z"
    }
  }
}
```

* **400** `{ "error": "invalid_contributor_alias", "message": "Send a Community Notes alias or its x.com/i/communitynotes/u URL." }`
* **401** `{ "error": "unauthenticated", "message": "Authentication required." }`
* **402** `{ "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }`
* **403** `{ "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }`
* **404** `{ "error": "contributor_not_found", "message": "Contributor not found. Check the alias on its x.com/i/communitynotes/u page." }`
* **424** `{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }`
* **429** `{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }`
* **502** `{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }`
* **503** `{ "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.