Skip to main content
The client groups scraping functions by platform. Each function validates your input against the endpoint’s schema, sends the request, and returns the typed data payload wrapped in an ApiResult. Every call costs one credit.
For the exact request fields and response shape of any function, open the API Reference — each endpoint page shows the equivalent SDK call alongside its schema.

​
client.x — X (Twitter)

const res = await client.x.getUserTweets({ userId: '44196397', count: 40 });
if (res.type === 'success') console.log(res.data);
FunctionWhat it returns
getTweetDetailA tweet with its full reply thread
searchTweets matching X advanced-search operators
searchUsersX users matching a keyword
getUserAn X user profile by handle
getUserTweetsA user’s tweets timeline
getUserRepliesA user’s replies
getUserMediaA user’s media tweets (photos and videos)
getFollowersA user’s followers
getFollowingAccounts a user follows
getTweetRetweetersUsers who retweeted a tweet
getTweetQuotesQuote tweets of a tweet

​
client.reddit — Reddit

const res = await client.reddit.listSubredditPosts({
  subreddit: 'programming',
  sort: 'top',
});
if (res.type === 'success') console.log(res.data);
FunctionWhat it returns
getPostA post with its full comment tree
getCommentA single comment with its surrounding thread
getSubredditSubreddit metadata
getUserA user profile
listUserPostsA user’s posts
listUserCommentsA user’s comments
listUserOverviewA user’s mixed post/comment activity
listSubredditPostsPosts in a subreddit feed
listSubredditCommentsRecent comments in a subreddit
searchAllPosts, communities, and users at once
searchCommunitiesCommunities (subreddits)
searchPostsPosts
searchUsersUsers
searchCommentsComments

​
client.linkedin — LinkedIn

const res = await client.linkedin.searchJobs({
  keyword: 'engineer',
  location: 'Remote',
});
if (res.type === 'success') console.log(res.data);
FunctionWhat it returns
getCompanyFromUrlA company by its universal name
getProfileFromUrlA profile by its public identity
getJobA job posting by URL
getPostsFromCompanyPosts published by a company
getPostsFromProfilePosts published by a profile
getPostDetailA single post by its activity URN
getActivityCommentsThe comment thread on a post
getProfileCommentsComments authored by a member
getProfileReactionsPosts a member reacted to
getPostReactionsMembers who reacted to a post
searchAllResults across every vertical
searchCompaniesCompanies
searchCoursesCourses
searchEventsEvents
searchGroupsGroups
searchJobsJobs, with location and facet filters
searchPeoplePeople
searchPostsPosts, with sort and date filters
searchProductsProducts
searchSchoolsSchools
searchServicesServices

​
Next steps

Account management

Create API keys and manage credits from code.

Errors

Handle API and network failures predictably.