v

latestOpenAPI 3.1.02026-08-09127104507.8 KB
Users

Search users by name or username

Search users by name or username.

get/api/v1/x/users/search

Query parameters

qstring required

User search query

cursorstring

Pagination cursor for user search

minFollowersinteger

Minimum follower count. Filtering happens before billing.

maxFollowersinteger

Maximum follower count. Missing counts pass this maximum.

minFollowinginteger

Minimum following count.

maxFollowinginteger

Maximum following count.

minStatusesinteger

Minimum post count. minPosts is also accepted.

maxStatusesinteger

Maximum post count. maxPosts is also accepted.

minAccountAgeDaysinteger

Minimum account age in whole days.

verifiedOnlyboolean

Only return verified profiles.

verifiedTypestring

Match the verification type exactly, ignoring case.

hasWebsiteboolean

Only return profiles with a website.

hasLocationboolean

Only return profiles with a location.

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.

Response

User search results

has_next_pageboolean required
next_cursorstring required

Example response

{
  "users": [
    {
      "id": "9876543210",
      "username": "elonmusk",
      "name": "Elon Musk"
    }
  ],
  "has_next_page": true,
  "next_cursor": "DAACCgACGRElMJcAAA"
}