Skip to main content
GET
Search
💳 1 credit per request

Authorizations

X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Query Parameters

query
string
required

The search query text

Example:

"AI"

type
enum<string>
default:Top

The type of search results to return. Defaults to Top if not provided.

Available options:
Top,
Latest,
People,
Photos,
Media,
Lists
Example:

"Top"

cursor
string

Pagination cursor from a previous response to get the next page of results

Response

Successful response

Key Response Fields:

Pagination:

  • data.cursor.bottom: Pass as cursor query param to get the next page of results
  • data.cursor.top: Cursor for the previous/newer page

Search Results (type=Top):

  • data.result.timeline.instructions[0].entries[]: Array of result entries (type TimelineAddEntries)

People Carousel (first entry when type=Top):

  • entries[0].content.items[]: Array of matched user profiles displayed in a carousel
  • entries[0].content.header.text: Will be People
  • Each user at .item.itemContent.user_results.result:
    • .rest_id: User's numeric ID
    • .is_blue_verified: Blue checkmark status
    • .legacy.name: Display name
    • .legacy.screen_name: Handle (username without @)
    • .legacy.description: Bio
    • .legacy.followers_count: Follower count
    • .legacy.friends_count: Following count
    • .legacy.profile_image_url_https: Profile picture URL
    • .legacy.verified_type: Business for business accounts

Tweet Results (subsequent entries):

  • Each tweet at entries[].content.itemContent.tweet_results.result:
    • .rest_id: Tweet ID
    • .legacy.full_text: Tweet text
    • .legacy.created_at: Timestamp
    • .views.count: View count (string)
    • .legacy.favorite_count: Likes
    • .legacy.retweet_count: Retweets
    • .legacy.reply_count: Replies
    • .legacy.quote_count: Quote tweets
    • .legacy.bookmark_count: Bookmarks

Feedback Actions:

  • data.result.timeline.responseObjects.feedbackActions[]: Internal feedback metadata (can ignore)