@bridgly/sdk is the official
TypeScript/JavaScript client for the Bridgly API. It
wraps the supported scraping endpoints — plus API-key and
billing management — in typed methods, so your editor autocompletes each request
field and knows the exact shape of every response.
Fully typed
Request and response types come from the same schemas the API validates
against.
Typed results
API and network failures return typed error results you can branch on.
Invalid input can throw a validation error before a request is sent.
One client, every platform
Platform namespaces such as
client.x, client.reddit, and
client.linkedin, plus client.apiKeys and client.billing.Built-in fetch
Uses your runtime’s built-in
fetch and Zod for validation. Works in
Node.js 18+ and modern server runtimes.Install
Create a client
Construct the client once with your API key and reuse it across your app. Get a key from the API Keys page of your dashboard. Replace the placeholder below with a key from your server’s environment or secret store.Configuration
string
required
Your Bridgly API key. Starts with
bgly_. The client throws immediately if
this is missing or empty.string
Override the API base URL. Defaults to the hosted Bridgly API. Useful for
pointing at a staging environment.
Next steps
Quickstart
Make your first typed call and read the result.
Functions
Browse the scraping functions available for each platform.
Account management
Create keys and manage credits from code.
Errors
Handle API and network failures predictably.