Bright Data SDK

Official TypeScript/JavaScript SDK for Bright Data APIs. Currently supports Web Unlocker API.

Features

• 🔓 Web Unlocker API - Bypass anti-bot measures and access any website
• 🛡️ Built-in error handling - Comprehensive error handling and retries
• 📝 TypeScript support - Full TypeScript definitions included

Installation

npm install @brightdata/sdk

Quick start

import { BrightDataClient } from '@brightdata/sdk';

const client = new BrightDataClient('your-api-key', zone: 'web_unlocker1');

async function example() {
  try {
    const result = await client.webUnlocker.unlock('https://example.com');
    console.log(result.content);
  } catch (error) {
    console.error('Error:', error.message);
  }
}

Web Unlocker API

// Simple unlock
const result = await client.webUnlocker.unlock('https://example.com');

// With options
const result = await client.webUnlocker.unlock('https://example.com', {
    country: 'US',
    format: 'raw',
    method: 'GET',
    data_format: 'markdown'
});

Error Handling

import { BrightDataError } from '@brightdata/sdk';

try {
  const result = await client.webUnlocker.unlock('https://example.com');
} catch (error) {
  if (error instanceof BrightDataError) {
    console.log('Status Code:', error.statusCode);
    console.log('Request ID:', error.requestId);
    console.log('Response:', error.response);
  }
}