Skip to main content
All job types use the /api/v1/search/live POST endpoint and follow the same structure: a top-level type to define the data source, and a set of arguments defining the parameters of the job.

Tweet Search

Search tweets using Twitter query syntax

User Profiles

Get user profile information and timelines

Tweet Interactions

Get replies, retweets, and specific tweets by ID

Social Networks

Get followers, following, and trending topics
There are three supported job types:
  • twitter: Uses best available auth method
  • twitter-credential: Supports advanced queries and search parameters
  • twitter-apify: Uses Apfiy actor for larger payloads
Parameters:
  • type (string, required): The operation type (see capabilities below)
  • query (string): The query to execute
  • max_results (int, optional): Number of results to return
  • next_cursor (string, optional): Pagination cursor

​
searchbyquery

Search tweets using Twitter query syntax 
{
  "type": "twitter",
  "arguments": {
    "type": "searchbyquery",
    "query": "gopher_ai",
    "max_results": 10
  }
}

​
getreplies

Get replies to a specific tweet 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "getreplies",
    "query": "1234567890", // tweet id
    "max_results": 20
  }
}

​
getretweeters

Get users who retweeted a specific tweet 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "getretweeters",
    "query": "1234567890", // tweet id
    "max_results": 50
  }
}

​
getbyid

Get specific tweet by ID 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "getbyid",
    "query": "1881258110712492142" // tweet id
  }
}

​
gettweets

Get tweets from a user’s timeline 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "gettweets",
    "query": "gopher_ai",
    "max_results": 50
  }
}

​
searchbyprofile

Get user profile information 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "searchbyprofile",
    "query": "gopher_ai"
  }
}

​
getprofilebyid

Get user profile by user ID 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "getprofilebyid",
    "query": "44196397" // user id
  }
}

​
getfollowers

Get followers of a profile 
{
  "type": "twitter-apify",
  "arguments": {
    "type": "getfollowers",
    "query": "gopher_ai",
    "max_results": 200
  }
}

​
getfollowing

Get users that a profile is following 
{
  "type": "twitter-apify",
  "arguments": {
    "type": "getfollowing",
    "query": "gopher_ai",
    "max_results": 200
  }
}

​
gettrends

Get trending topics 
{
  "type": "twitter-credential",
  "arguments": {
    "type": "gettrends"
  }
}
⌘I