Functions

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. Calls are billed in credits; see Credits. Invalid inputs can throw a validation error before a request is sent.

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: 10 });
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getTweetDetail`	A tweet and the first page of top-level replies
`search`	Tweets matching X advanced-search operators
`searchUsers`	X users matching a keyword
`getUser`	An X user profile by handle
`getUserTweets`	A user’s tweets timeline
`getUserReplies`	A user’s replies
`getUserMedia`	A user’s media tweets (photos and videos)
`getFollowers`	A user’s followers
`getFollowing`	Accounts a user follows
`getTweetRetweeters`	Users who retweeted a tweet
`getTweetQuotes`	Quote tweets of a tweet

`client.reddit` — Reddit

const res = await client.reddit.listSubredditPosts({
  subreddit: 'programming',
  sort: 'top',
  count: 10,
});
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getPost`	A post with nested comments; collapsed replies are omitted
`getComment`	A single comment with its surrounding thread
`getSubreddit`	Subreddit metadata
`getUser`	A user profile
`listUserPosts`	A user’s posts
`listUserComments`	A user’s comments
`listUserOverview`	A user’s mixed post/comment activity
`listSubredditPosts`	Posts in a subreddit feed
`listSubredditComments`	Recent comments in a subreddit
`searchAll`	Posts, communities, and users at once
`searchCommunities`	Communities (subreddits)
`searchPosts`	Posts
`searchUsers`	Users
`searchComments`	Comments

`client.linkedin` — LinkedIn

const res = await client.linkedin.searchJobs({
  keyword: 'engineer',
  location: 'Remote',
  count: 10,
});
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getCompanyFromUrl`	A company by its universal name
`getProfileFromUrl`	A profile by its public identity
`getJob`	A job posting by URL
`getPostsFromCompany`	Posts published by a company
`getPostsFromProfile`	Posts published by a profile
`getPostDetail`	A single post by its activity URN
`getActivityComments`	The comment thread on a post
`getProfileComments`	Comments authored by a member
`getProfileReactions`	Posts a member reacted to
`getPostReactions`	Members who reacted to a post
`searchAll`	Results across every vertical
`searchCompanies`	Companies
`searchCourses`	Courses
`searchEvents`	Events
`searchGroups`	Groups
`searchJobs`	Jobs, with location and facet filters
`searchPeople`	People
`searchPosts`	Posts, with sort and date filters
`searchProducts`	Products
`searchSchools`	Schools
`searchServices`	Services

`client.github` — GitHub

const res = await client.github.getProfile({ username: 'torvalds' });
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getProfile`	A user profile with their pinned repositories
`getContributions`	The contribution calendar and aggregated totals
`listRepositories`	A user’s public repositories (paginated)
`listStarred`	Repositories a user has starred (paginated)
`listProjects`	A user’s public projects (paginated)
`searchRepositories`	Repository search
`searchCode`	Code search across public repositories
`searchCommits`	Commit search across public repositories
`searchIssues`	Issue search
`searchPullRequests`	Pull-request search
`searchDiscussions`	Discussion search
`searchUsers`	User and organization search
`searchTopics`	Topic search

const res = await client.github.searchRepositories({
  query: 'web framework',
  language: 'TypeScript',
  stars: { gt: 10000 },
  sort: 'stars',
  fork: 'exclude',
  order: 'desc',
  count: 10,
});
if (res.type === 'success') console.log(res.data.repositories);

`client.instagram` — Instagram

const res = await client.instagram.getFollowers({
  username: 'instagram',
  count: 10,
});
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getUser`	A user profile by username
`getUserPosts`	A user’s posts by username
`getFollowers`	A user’s followers by username
`getFollowing`	Accounts a user follows by username
`getPost`	A post by shortcode
`getPostComments`	Comments on a post by shortcode
`searchUsers`	Users matching a keyword

Use the username shown in the profile URL. For posts and comments, use the shortcode in the post URL, such as DdHNbqDJusb from https://www.instagram.com/p/DdHNbqDJusb/. To fetch the next page, pass the response’s end_cursor as after.

`client.tiktok` — TikTok

const res = await client.tiktok.getUser({ uniqueId: 'tiktok' });
if (res.type === 'success') console.log(res.data);

Function	What it returns
`getUser`	A user profile by username

Pass the username from the profile URL, such as tiktok from https://www.tiktok.com/@tiktok.

`client.youtube` — YouTube

const res = await client.youtube.getVideo({
  url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
  includeTranscript: true,
});
if (res.type === 'success') console.log(res.data.transcript?.text);

Function	What it returns
`getVideo`	Title, description, stats, channel, caption tracks, and the timed transcript

TypeScript SDK

`client.x` — X (Twitter)

`client.reddit` — Reddit

`client.linkedin` — LinkedIn

`client.github` — GitHub

`client.instagram` — Instagram

`client.tiktok` — TikTok

`client.youtube` — YouTube

Next steps

Account management

Errors

​client.x — X (Twitter)

​client.reddit — Reddit

​client.linkedin — LinkedIn

​client.github — GitHub

​client.instagram — Instagram

​client.tiktok — TikTok

​client.youtube — YouTube

​Next steps

Account management

Errors

`client.x` — X (Twitter)

`client.reddit` — Reddit

`client.linkedin` — LinkedIn

`client.github` — GitHub

`client.instagram` — Instagram

`client.tiktok` — TikTok

`client.youtube` — YouTube

Next steps