Search users

Requested result counts are upper bounds for paid authenticated calls. When remaining credits cannot cover the full page or ID list, Xquik returns fewer results. If zero paid results are affordable, it returns 402 insufficient_credits.

1 credit per result returned · All plans from $0.00012/credit

curl "https://xquik.com/api/v1/x/users/search?q=xquik" \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

The Node.js and Python snippets shape durable search-result rows instead of printing full profile pages. Persist searchRows or search_rows with nextCursor or next_cursor before requesting the next page.

Direct user search handoff

Use GET /x/users/search when a CRM, enrichment, creator discovery, support, or agent workflow has a name, brand, or handle fragment and needs matching X profiles. Use Get User when you have one exact ID or username. Use Get Users (Batch) when you already have numeric user IDs. Store search_query, result_rank, user_id, username, display_name, profile metrics, verification state, profile_image_url, has_next_page, and next_cursor. Treat next_cursor as opaque and pass it back as cursor only when has_next_page is true. Zero affordable results return 402 insufficient_credits.

Query parameters

string

required

Search query string.

cursor

string

Pagination cursor from a previous response. Omit for the first page.

Headers

x-api-key

string

required

Your API key. Session cookie authentication is also supported.

Response

users

object[]

Array of matching user profiles.

Show User object fields

string

X user ID.

username

string

X username.

name

string

Display name.

description

string

Profile bio.

followers

number

Follower count.

following

number

Following count.

verified

boolean

Verified status.

profilePicture

string

Profile image URL.

location

string

Profile location.

createdAt

string

Account creation date (ISO 8601).

statusesCount

number

Total number of tweets posted. Omitted if unavailable.

coverPicture

string

Cover/banner image URL. Omitted if unavailable.

mediaCount

number

Total number of media tweets posted. Omitted if unavailable.

canDm

boolean

Whether the user accepts direct messages. Omitted if unavailable.

url

string

Website URL from profile. Omitted if empty.

favouritesCount

number

Total number of tweets liked. Omitted if unavailable.

hasCustomTimelines

boolean

Whether the user has custom timelines. Omitted if unavailable.

isTranslator

boolean

Whether the user is an X translator. Omitted if unavailable.

withheldInCountries

string[]

Country codes where the account is withheld. Omitted if empty.

possiblySensitive

boolean

Whether the account is flagged as possibly sensitive. Omitted if unavailable.

pinnedTweetIds

string[]

IDs of pinned tweets. Omitted if none.

isAutomated

boolean

Whether the account is marked as automated. Omitted if unavailable.

automatedBy

string

Username of the account operator if automated. Omitted if not automated.

unavailable

boolean

Whether the account is unavailable. Omitted if available.

unavailableReason

string

Reason the account is unavailable. Omitted if available.

verifiedType

string

Verification type (e.g. Business, Government). Omitted if not verified or standard blue check.

profile_bio

object

Structured profile bio with entity annotations. Omitted if unavailable.

has_next_page

boolean

Whether more results are available.

next_cursor

string

Cursor for the next page.

{
  "users": [
    {
      "id": "987654321",
      "username": "xquikcom",
      "name": "Xquik",
      "followers": 10000,
      "verified": true,
      "description": "All-in-one X automation platform"
    }
  ],
  "has_next_page": true,
  "next_cursor": "DAACCgACGE..."
}

{ "error": "missing_query" }

{ "error": "unauthenticated" }

{ "error": "no_subscription" }

No active subscription or insufficient credits. Possible error values: no_subscription, subscription_inactive, no_credits, insufficient_credits.

{ "error": "x_api_unavailable" }

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

{ "error": "rate_limit_exceeded", "retryAfter": 60 }

Your tier rate limit was exceeded. Wait for the Retry-After header before retrying.

{ "error": "x_api_unavailable" }

The normalized v1 response contract can return 424 when the read service is unavailable.

Next steps: Get User to fetch full details, or Search Tweets to find tweets by query.

Documentation Index

​Direct user search handoff

​Query parameters

​Headers

​Response

Direct user search handoff

Query parameters

Headers

Response