Communities

Search members of a community by name

Changed on

Finds a community's members by name or username, as the search box on X's members page does. X checks up to 10 accounts that match, & the answer holds the members among them, each with its role. Each member costs 1 credit. An answer without members is free.

get/x/communities/{id}/members/search

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/communities/{id}/members/search
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Path parameters

idstring required
Example:1500000000000000000

X Community ID, a number up to 19 digits. Another value gets a free 400 invalid_community_id before X is read.

Query parameters

qstring required

Name or username to find members by, such as marckohlbrugge. A leading @ is dropped. Alias query. Xquik's cap is 4,096 characters.

minFollowersinteger

Whole number from 0.

Minimum follower count. Profiles the filter drops cost nothing.

maxFollowersinteger

Whole number from 0.

Maximum follower count. A profile without a count passes.

minFollowinginteger

Whole number from 0.

Profiles must follow at least this many accounts.

maxFollowinginteger

Whole number from 0.

Profiles may follow at most this many accounts.

minStatusesinteger

Whole number from 0.

Minimum post count. minPosts is also accepted.

maxStatusesinteger

Whole number from 0.

Maximum post count. maxPosts is also accepted.

minAccountAgeDaysinteger

Whole number from 0.

Minimum account age in whole days.

verifiedOnlyboolean

Only return verified profiles.

blueVerifiedOnlyboolean

Only return profiles X marks as blue verified. X marks many business & government accounts blue too. Use verifiedType for 1 badge type.

verifiedTypestring

Match the verification type exactly, ignoring case.

hasWebsiteboolean

Only return profiles with a website.

hasLocationboolean

Only return profiles with a location.

hasEmailboolean

Only return profiles that publish an email.

businessEmailOnlyboolean

Only return profiles that publish an email outside free webmail, such as Gmail.

emailDomainsstring

Only return profiles with an email at one of these domains. Separate domains with commas. Subdomains match.

bioContainsstring

Match any comma-separated or line-separated bio term, ignoring case.

locationContainsstring

Match a location substring, ignoring case.

usernameContainsstring

Match a username substring, ignoring case.

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

Community members X found for the name

filtered_countinteger

Whole number from 0.

has_next_pageboolean required
next_cursorstring required

Cursor for the next page. Send it unchanged.

Example response

{
  "users": [
    {
      "id": "34743251",
      "username": "SpaceX",
      "name": "SpaceX",
      "followers": 41936873,
      "following": 127,
      "verified": true,
      "isBlueVerified": true,
      "isVerified": true,
      "profilePicture": "https://pbs.twimg.com/profile_images/1697749409851985920/HbrI04tM_normal.jpg",
      "profilePictureOriginal": "https://pbs.twimg.com/profile_images/1697749409851985920/HbrI04tM.jpg",
      "coverPicture": "https://pbs.twimg.com/profile_banners/34743251/1681251194",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/34743251/1681251194",
      "description": "SpaceX designs, manufactures and launches the world's most advanced rockets and spacecraft",
      "location": "Earth",
      "createdAt": "Thu Apr 23 21:53:30 +0000 2009",
      "statusesCount": 11834,
      "mediaCount": 4713,
      "protected": false,
      "url": "http://spacex.com",
      "contactInfo": {
        "links": [
          {
            "url": "http://spacex.com",
            "network": "website",
            "source": "url"
          }
        ]
      },
      "favouritesCount": 529,
      "possiblySensitive": false,
      "pinnedTweetIds": [
        "2104354931595423762"
      ],
      "verifiedType": "Business",
      "profile_bio": {
        "description": "SpaceX designs, manufactures and launches the world's most advanced rockets and spacecraft",
        "entities": {
          "description": {},
          "url": {
            "urls": [
              {
                "display_url": "spacex.com",
                "expanded_url": "http://spacex.com",
                "indices": [
                  0,
                  23
                ],
                "url": "https://t.co/VOJ6qEctND"
              }
            ]
          }
        }
      },
      "hasGraduatedAccess": true,
      "parodyCommentaryFanLabel": "None",
      "professional": {
        "category": [],
        "professional_type": "Business",
        "rest_id": "1681839322029502464"
      },
      "profileDescriptionLanguage": "en",
      "profileImageShape": "Square",
      "profileTranslatorType": "none",
      "superFollowEligible": false
    },
    {
      "id": "20536157",
      "username": "Google",
      "name": "Google",
      "followers": 31909314,
      "following": 298,
      "verified": true,
      "isBlueVerified": true,
      "isVerified": true,
      "profilePicture": "https://pbs.twimg.com/profile_images/2042749771337564160/AgOFPEL3_normal.jpg",
      "profilePictureOriginal": "https://pbs.twimg.com/profile_images/2042749771337564160/AgOFPEL3.jpg",
      "coverPicture": "https://pbs.twimg.com/profile_banners/20536157/1780004508",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/20536157/1780004508",
      "description": "Here to help.",
      "location": "Mountain View, CA",
      "createdAt": "Tue Feb 10 19:14:39 +0000 2009",
      "statusesCount": 251787,
      "mediaCount": 38271,
      "protected": false,
      "url": "https://blog.google/newsletter-subscribe/",
      "contactInfo": {
        "links": [
          {
            "url": "https://blog.google/newsletter-subscribe/",
            "network": "website",
            "source": "url"
          }
        ]
      },
      "favouritesCount": 5327,
      "possiblySensitive": false,
      "pinnedTweetIds": [
        "2105388143902175529"
      ],
      "verifiedType": "Business",
      "profile_bio": {
        "description": "Here to help.",
        "entities": {
          "description": {},
          "url": {
            "urls": [
              {
                "display_url": "blog.google/newsletter-sub…",
                "expanded_url": "https://blog.google/newsletter-subscribe/",
                "indices": [
                  0,
                  23
                ],
                "url": "https://t.co/RS3iU87BGe"
              }
            ]
          }
        }
      },
      "hasGraduatedAccess": true,
      "parodyCommentaryFanLabel": "None",
      "professional": {
        "category": [
          {
            "icon_name": "IconBriefcaseStroke",
            "id": 713,
            "name": "Science & Technology"
          }
        ],
        "professional_type": "Business",
        "rest_id": "1504886752259059716"
      },
      "profileDescriptionLanguage": "en",
      "profileImageShape": "Square",
      "profileTranslatorType": "regular",
      "superFollowEligible": false
    }
  ],
  "has_next_page": false,
  "next_cursor": ""
}

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

  • 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