TypeScript SDK

Installation

Requires Node.js 18+ or any modern browser runtime.

Initialize

Import and instantiate the client once at the top of your file or module:

import { SubScraperClient } from '@subscraper/sdk';

const client = new SubScraperClient({
  apiKey: 'sk-your-api-key-here' // Get from dashboard
});

Examples

// Search Reddit posts by keyword
const result = await client.searchPosts({
  query: 'nextjs server components',
  limit: 10,
  sort: 'top',
  time: 'year'
});

console.log(result.results);
// [{ title: "...", subreddit: "...", score: 412, ... }]

// Fetch a user's karma, bio, and account age
const profile = await client.getUserProfile({
  username: 'shittymorph'
});

console.log(`Total karma: ${profile.karma.post + profile.karma.comment}`);

// Get hot posts from a subreddit
const feed = await client.getCommunityPosts({
  subreddit: 'MachineLearning',
  sort: 'hot',
  limit: 25
});

console.log(feed.posts);

// Fetch a post and its full comment tree
const thread = await client.getPost({
  url: 'https://reddit.com/r/webdev/comments/abc123/...',
  commentLimit: 100
});

console.log(thread.title);
console.log(thread.comments); // Nested tree

All Available Methods