Back to Skills

bright-data-best-practices

Build production-ready Bright Data integrations with best practices baked in. Reference documentation for developers using coding assistants (Claude Code, Cursor, etc.) to implement web scraping, search, browser automation, and structured data extraction. Covers Web Unlocker API, SERP API, Web Scraper API, and Browser API (Scraping Browser).

240stars35forksUpdated 8/5/2026

Security Assessment

Medium Risk(68/100)

Detected risks:

Large-Scale Scraping of Third-Party and Social Sites(The Web Scraper API provides pre-built scrapers for sites such as Amazon, LinkedIn, Instagram, and TikTok, many of which prohibit automated scraping in their terms of service., The overall platform is oriented toward extracting web and search-engine data at scale, which raises terms-of-service and data-protection compliance concerns depending on how it is used.)
Anti-Bot Detection Bypass(The Web Unlocker API is described as automatically bypassing bot-detection systems on target websites, which is a circumvention capability that can be used to defeat sites' access controls., The Browser API and scraping-browser features are geared toward evading detection while automating interactions against third-party sites.)
Security Score68/100

About bright-data-best-practices

This skill is a reference guide for building production integrations with Bright Data's web data-collection platform, aimed at developers using coding assistants like Claude Code or Cursor. It covers four APIs: the Web Unlocker (an HTTP scraping proxy that auto-bypasses bot detection), the SERP API (structured search-engine result extraction for Google, Bing, Yandex, and DuckDuckGo), the Web Scraper API (pre-built scrapers for sites such as Amazon, LinkedIn, Instagram, and TikTok), and the Browser API (full browser automation over CDP/WebDriver for Puppeteer, Playwright, and Selenium).

The documentation provides a decision table for picking the most specific API per task, a shared authentication model using environment variables and Bearer tokens (or the bdata CLI's login flow), and concrete request examples with key parameters, geo-targeting, markdown and screenshot output, async bulk patterns, and billing notes. Reference files expand each API and cover CLI setup and troubleshooting. Its core value is helping developers extract web and search data at scale reliably.

Target users are data engineers and developers building scraping and search-extraction pipelines. It is worth noting the platform's central capability is circumventing anti-bot detection and scraping sites including social networks, which is a dual-use, terms-of-service-sensitive area: the same infrastructure that powers legitimate large-scale data collection can also be used to evade the access controls of sites that prohibit scraping. Credentials are handled through standard environment variables and the official CLI with no exfiltration, so the concern is the nature of the activity rather than any malicious code in the skill itself.

FAQ

Which Bright Data APIs does this cover?

The Web Unlocker API, SERP API, Web Scraper API, and Browser API (Scraping Browser), with a decision table for choosing the most specific one per task.

How is authentication configured?

Through environment variables such as BRIGHTDATA_API_KEY and zone names, using a Bearer token header for REST calls, or the bdata CLI's login command which handles credentials automatically.

When should I use the Browser API versus the Web Unlocker?

Use the Web Unlocker for simple HTTP page fetches with no interaction; use the Browser API for clicking, scrolling, form-filling, running JavaScript, or Puppeteer/Playwright/Selenium automation. The docs warn never to combine the Web Unlocker with a headless browser.

How is billing structured for the SERP API?

You pay per 1,000 successful requests, and asynchronous retrieve calls are not billed.

Are there compliance considerations?

Yes. These tools bypass bot detection and scrape third-party and social sites, so usage should respect the target sites' terms of service and applicable data-protection laws; the skill itself is documentation and does not contain malicious code.

All Files

6 files
SKILL.md14.1 KB
View
references/web-scraper-api.md10.8 KB
View
references/web-unlocker.md12.2 KB
View
references/browser-api.md17.3 KB
View
references/cli-setup.md4.0 KB
View
references/serp-api.md13.5 KB
View

Install bright-data-best-practices

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill