SDK overview

​

Installation

npm install @socialrouter/sdk

​

Quick example

import { SocialRouter } from "@socialrouter/sdk";

const sr = new SocialRouter({ apiKey: "sr_live_your_key" });

const run = await sr.run("linkedin/profile.info", {
  url: "https://www.linkedin.com/in/satyanadella",
});

console.log(run.served_by); // "brightdata/linkedin"
console.log(run.data);
// [{ name: "Satya Nadella", title: "Chairman and CEO at Microsoft", ... }]

​

What’s included

• run(service, input): one generic entry point, typed per service
• Typed per-service methods, grouped by platform: sr.reddit.subredditPosts({ … })
• Correlated input types: a URL service takes url/urls, a query service takes query/queries, and mixing them is a compile error
• Typed options per service: options: { sort: "top" } on reddit/subreddit.posts, and a compile error on a service that declares none
• Catalogue access: listServices(), getService(), listSources()
• Error classes per HTTP status (AuthenticationError, InsufficientCreditsError, RateLimitError)
• Uses native fetch(), so Node.js 18+ is required

​

Typed methods

await sr.reddit.subredditPosts({
  url: "https://www.reddit.com/r/programming",
  options: { sort: "top", time: "week" },
});

await sr.googlemaps.placeSearch({ queries: ["coffee shops in Brooklyn"] });

​

Next steps