Skip to main content
skill CX Codex

brightdata-sdk — Claude Code skill: what it does, how to install

The brightdata-sdk skill helps write Python and Node.js code for Bright Data scraping, SERP, Web Unlocker, and Scraper Studio. Use it for recurring jobs kept in a repository.

MIT 466 installs ★ 272 updated 2026-10-15

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add brightdata/skills --skill brightdata-sdk -a claude-code
Open on GitHub

What brightdata-sdk does

brightdata-sdk guides application code that calls Bright Data repeatedly. The Python package is brightdata-sdk; the Node.js package is @brightdata/sdk. Python follows an async-first shape, while Node.js uses camelCase and requires the client to be closed with close() or await using.

The skill covers page fetching, SERP queries, platform scrapers, crawling, dataset access, Browser API connection strings, and Scraper Studio. It chooses the language reference from project files: pyproject.toml or .py points to Python, while package.json, .js, .mjs, or .ts points to Node.js. Both SDKs check BRIGHTDATA_API_TOKEN first, then BRIGHTDATA_API_KEY, and can fall back to credentials saved by the Bright Data CLI.

On first use, the SDKs can create the sdk_unlocker and sdk_serp zones in the account. A one-off shell check belongs to brightdata-cli; an AI application that selects tools at runtime belongs to brightdata-mcp.

What it helps with

  • build a recurring scraper in Python or Node.js
  • add SERP lookup to a backend service
  • feed Bright Data datasets into an ETL step
  • wrap Bright Data calls in a custom API
  • connect application code to Browser API or Scraper Studio

Example prompts for the agent

  • Write a Python job that fetches pages through brightdata-sdk on a schedule and reads the token from an environment variable.
  • Add SERP search to this Node.js service with @brightdata/sdk, then close the client after the request.
  • Inspect the repository files, choose the matching SDK reference, and wire a Bright Data call into the ETL pipeline.

How to install brightdata-sdk

1Skills CLI (Vercel)

npx skills add brightdata/skills --skill brightdata-sdk -a claude-code

2Manually: put the files in place

~/.claude/skills/brightdata-sdk/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/brightdata-sdk/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about brightdata-sdk

How do I install brightdata-sdk in Claude Code?

Run npx skills add brightdata/skills --skill brightdata-sdk -a claude-code, then check ~/.claude/skills/brightdata-sdk/SKILL.md.

What does brightdata-sdk do?

It guides Python and Node.js code that calls Bright Data from recurring jobs, pipelines, backend services, and other versioned application code.

Which environment variables can the SDK use for authentication?

The SDKs look for BRIGHTDATA_API_TOKEN first and accept BRIGHTDATA_API_KEY as an alternative. They can also use credentials saved by the Bright Data CLI.

Source text

SKILL.md · MIT
---
name: brightdata-sdk
description: Bright Data's Python and Node.js SDKs for calling Web Scraper API, SERP, Web Unlocker and Scraper Studio from application code. Use when the user is writing code they keep that calls Bright Data on a schedule or inside a pipeline, when the same job runs again and again, when a Bright Data package is imported in Python or Node.js, when the user wants their own API or service built on top of Bright Data ("build me a scraper API", "wrap this in an endpoint"), or when the user names the SDK. Not for one-off checks typed at a shell, which belong to brightdata-cli. Not for an AI app that chooses its tools at run time, which belongs to brightdata-mcp. Not for install, login or API key problems, which belong to agent-onboarding.
---

# Bright Data SDKs

Two published packages, one skill. The request is the same in both languages, so follow the language the repo already uses.

| Language | Package | Registry | Install |
|---|---|---|---|
| Python | `brightdata-sdk` | PyPI | `pip install brightdata-sdk` |
| Node.js | `@brightdata/sdk` | npm | `npm install @brightdata/sdk` |

## Which reference to open

- A `pyproject.toml`, a `requirements.txt` or `.py` files are in the project: open `references/python.md`.
- A `package.json` or `.js`, `.mjs` and `.ts` files are in the project: open `references/nodejs.md`.
- Both languages are present and neither clearly owns the job: ask which runtime will run it, then open that one file.

## When the SDK is the right surface

The user keeps the code. A cron job, a backend service, an ETL step, an enrichment pipeline: anything where the same call runs again and again from a file under version control. Reach for the SDK the moment a Bright Data call is going to live in a repo rather than in a terminal.

Two neighbours own the other cases. A one-off check typed at a shell is `brightdata-cli`. An AI app that picks its tools at run time is `brightdata-mcp`.

## Auth

Install, login and API key problems belong to `agent-onboarding`, which owns credential paths and what a refused call means. See its `references/auth.md`.

The one fact this skill needs: both SDKs read `BRIGHTDATA_API_TOKEN` first, accept `BRIGHTDATA_API_KEY` as an alternate, and fall back to the credentials the Bright Data CLI stored at login. Never write a key into source. Both reference files show the key coming from the environment. To check that a key exists, run `node scripts/check-auth.mjs` from the `agent-onboarding` skill; never `cat`, `echo` or `jq` the credentials file or the variable, because whatever a command prints lands in the conversation and its logs.

## What both packages cover

Page fetch, SERP search, per-platform scrapers, a crawler, dataset access, Browser API connect strings, and a Scraper Studio namespace. The shape differs by language: Python is async first and uses snake_case, Node.js uses camelCase and has to be closed, either with `close()` by hand or with `await using` on modern runtimes. Read the reference file rather than translating method names by hand.

By default both SDKs create the zones `sdk_unlocker` and `sdk_serp` in the account when they are missing: Python when the client opens, Node on the first call that uses each zone. Tell the user before running code that will do that. Each reference file shows how to turn auto-creation off and use the account's own zones.

© brightdata · MIT · brightdata/skills

Similar skills

All skills for Backend and APIs →

From the same set14

The whole set →
scrape This skill helps an agent collect structured website data and choose between a ready scraper, Scraper Studio, or fetch for a one-off page. CX Codex +1 11,100installs search Routes agent queries to Google, Bing, or answer engines like Perplexity. Useful when work starts from an open-ended search query rather than a known URL. CX Codex +1 7,700installs bright-data-best-practices bright-data-best-practices — a reference skill that teaches a coding assistant which Bright Data API fits the task and how to wire it up. Handy when the agent builds a scraper or a bdata wrapper. CX Codex +1 1,800installs data-feeds data-feeds pulls structured data off known sites through pre-built Bright Data scrapers. Useful when you want clean JSON instead of raw HTML. CX Codex +1 425installs scraper-builder scraper-builder takes you from "I want data from site X" to a working scraper: site analysis, Bright Data API choice, selectors, pagination. CX Codex +1 415installs design-mirror The design-mirror skill reads a website’s visual language and applies it to an existing codebase. Use it when a UI needs to follow a reference site’s look. CX Codex +1 353installs fetch fetch — a skill for Claude Code retrieves a web page as markdown, HTML, or a screenshot. Resolves bot challenges and 403 blocks using Bright Data Web Unlocker. CX Codex +1 186installs billing billing — a skill for Claude Code and Codex that checks Bright Data balance, inspects spend per zone, and estimates upcoming job costs. CX Codex +1 185installs

Project sponsors

Companies that keep this analytics open