SDK quickstart

1. Install and construct the client

npm install @bridgly/sdk

pnpm add @bridgly/sdk

Replace the placeholder below with a key from your server’s environment or secret store.

import { Bridgly } from '@bridgly/sdk';

const client = new Bridgly({ apiKey: 'bgly_your_api_key' });

2. Make a call

Every scraping method takes a typed request object and returns a typed result. Here we fetch a Reddit user profile:

const res = await client.reddit.getUser({ username: 'spez' });

if (res.type === 'success') {
  console.log(res.data); // typed Reddit user profile
  console.log(res.creditsCost); // credits this call consumed
  console.log(res.timeMs); // how long it took
} else {
  console.error(res.status, res.message); // typed error
}

3. Branch on the result

Methods never throw for API or network errors. Instead they return a discriminated union you narrow with res.type:

type ApiResult<T> =
  | { type: 'success'; data: T; timeMs: number; creditsCost: number }
  | { type: 'error'; status: number; message: string };

Once you check res.type === 'success', TypeScript knows res.data is present and fully typed for that endpoint. In the error branch you get the HTTP status and a human-readable message. The SDK validates inputs before sending a request. Invalid inputs can throw a Zod validation error; see Errors & types.

Branch on res.status (the numeric HTTP code) rather than matching on message — messages are meant for humans and may change. See Errors & types.

Try other platforms

The same shape works across every platform. Swap the namespace and method:

const res = await client.linkedin.getProfileFromUrl({
  memberIdentity: 'williamhgates',
});
if (res.type === 'success') console.log(res.data);

const res = await client.x.search({ query: 'openai lang:en', count: 10 });
if (res.type === 'success') console.log(res.data);

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

TypeScript SDK

1. Install and construct the client

2. Make a call

3. Branch on the result

Try other platforms

Next steps

Functions

Errors

​1. Install and construct the client

​2. Make a call

​3. Branch on the result

​Try other platforms

​Next steps

Functions

Errors

1. Install and construct the client

2. Make a call

3. Branch on the result

Try other platforms

Next steps