Community Notes

Get a Community Notes contributor's note and rating counts

Changed on

Returns 1 Community Notes contributor by the alias X gives them. Includes note counts by rating, rating counts & the deleted notes count. Each lookup costs 1 credit.

get/x/community-notes/contributors/{alias}

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/community-notes/contributors/{alias}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Path parameters

aliasstring required

Community Notes contributor alias, or the URL-encoded contributor URL, such as x.com/i/communitynotes/u/ardent-beach-friarbird. Any letter case works.

Query parameters

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

Contributor profile

Example response

{
  "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"
    },
    "ratingsCount": {
      "awaitingMoreRatings": 703,
      "ratedAfterDecision": 154,
      "successful": {
        "helpfulCount": 27,
        "notHelpfulCount": 22,
        "total": 49
      },
      "unsuccessful": {
        "helpfulCount": 15,
        "notHelpfulCount": 4
      },
      "updatedAt": "2026-10-12T22:50:13.228Z"
    }
  }
}

Changes

  • 245194cd4ea7Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

  • d17988b4a85dRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property const value Ask the user to confirm a payment option before creating checkout. was added for the status

    • info

      removed the Ask the user to confirm a payment option before creating checkout. enum value from the //// response property for the response status

    • info

      removed the Ask the user to top up at /dashboard/account. This key cannot open checkout. enum value from the //// response property for the response status