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);
| Function | What it returns |
|---|---|
getTweetDetail | A tweet with its full reply thread |
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',
});
if (res.type === 'success') console.log(res.data);
| Function | What it returns |
|---|---|
getPost | A post with its full comment tree |
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',
});
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: '>10000',
sort: 'stars',
});
if (res.type === 'success') console.log(res.data.repositories);
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 |
Next steps
Account management
Create API keys and manage credits from code.
Errors
Handle API and network failures predictably.