twitter

Search

Search Twitter for tweets, users, photos, media, and more. Results are paginated — use the cursor parameter to fetch additional pages.

get/v1/scrape/twitter/search

Request

  • Base URL: https://api.sociavault.com
  • URL: https://api.sociavault.com/v1/scrape/twitter/search
  • Auth: API key in header X-API-Key

Query parameters

querystring required
Example:AI

The search query text

type'Top' | 'Latest' | 'People' | 'Photos' | 'Media' | 'Lists'
Example:Top

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

cursorstring

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

Response

Successful response

Key Response Fields:

Pagination:

  • has_more: false when this page returned no results — the signal to stop paginating (keep paging while true)
  • result_count: Number of results (tweets or users) on this page
  • 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)

Changes

No recorded changes to this operation across all 1 revision of this API.