Search users
GET/twitter/user/search
Search users by keyword. Paginated: use cursor / next_cursor.
Price: $0.0006 per request.
Parameters
querystringrequiredSearch query.
Example:
nasacursorstringPagination cursor. Leave empty for the first page, then pass
next_cursorfrom the previous response.
Example request
curl "https://api.cheapxapi.com/twitter/user/search?query=nasa" \
-H "x-api-key: YOUR_KEY"Response
Charged. Check status: success means data was returned; error (e.g. user not found) is also HTTP 200.
| Field | Type |
|---|---|
users | array of UserProfileSnake |
id | string |
name | string |
screen_name | string |
userName | string |
username | string |
location | string |
url | string |
description | string |
email | string |
protected | boolean |
verified | boolean |
isBlueVerified | boolean |
followers_count | integer |
following_count | integer |
friends_count | integer |
favourites_count | integer |
statuses_count | integer |
media_tweets_count | integer |
created_at | string |
profile_banner_url | string |
profile_image_url_https | string |
can_dm | boolean |
has_next_page | boolean |
next_cursor | string |
Status codes
- 200
- Charged. Check
status:successmeans data was returned;error(e.g. user not found) is also HTTP 200. - 400
- Invalid parameters (charged), or API key placed in the URL (not charged).
- 401
- Missing or invalid API key (not charged).
- 402
- Insufficient balance (not charged).
- 403
- Account disabled (not charged).
- 404
- Unknown endpoint (charged), or the requested item could not be found (not charged). Note: many endpoints report a missing user/tweet as HTTP 200 with
"status":"error"instead; those are charged. - 405
- Only GET is supported (not charged).
- 429
- Rate limit exceeded (not charged). Retry after the time in the
Retry-Afterheader. - 503
- Temporary service problem, or the endpoint is temporarily unavailable (not charged). Retry with exponential backoff.