Users

Changed on

Returns public profiles for up to 100 user IDs, usernames or profile links. Send ids or usernames, not both. Each returned profile costs 1 credit.

get/api/v1/x/users/batch

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/x/users/batch
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Query parameters

idsstring

Comma-separated numeric user IDs (1-100 values). Xquik ignores duplicate IDs and keeps the first-seen order. A longer URL fails at the edge before Xquik reads it.

usernamesstring

Comma-separated X usernames, with or without @, or profile links such as x.com/nasa (1-100 values), in place of ids. A name in another case is the same account. A longer URL fails at the edge before Xquik reads it.

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

Matched users plus reconciliation metadata.

filtered_countinteger

Profiles rejected by the requested filters.

has_next_pagefalse required

Batch lookups never paginate.

next_cursorstring required

Empty because batch lookups never paginate.

requested_countinteger required

Number of unique IDs requested.

processed_countinteger required

Number of requested IDs included in the lookup.

returned_countinteger required

Number of user profiles returned and charged.

unavailable_idsstring[] required

Processed IDs with no profile on X, in first-seen request order.

failed_idsstring[] required

Processed IDs that failed to load, in first-seen request order. They cost nothing. Retry them.

unprocessed_idsstring[] required

Requested IDs skipped because your credits ran out. Retry them after adding credits.

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
    }
  ],
  "requested_count": 2,
  "processed_count": 2,
  "returned_count": 1,
  "unavailable_ids": [
    "1234567890"
  ],
  "failed_ids": [],
  "unprocessed_ids": []
}

Changes

  • 45942c75fdc2Revision 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

    • 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