langchain-brightdata 0.1.8

LangChain integration for Bright Data web scraping and SERP APIs

langchain-brightdata

LangChain integration for Bright Data's web data APIs

Installation • Quick Start • Tools • Configuration • Resources

---

Overview

langchain-brightdata provides LangChain tools for Bright Data's web data APIs, enabling your AI agents to:

• Search - Query search engines with geo-targeting and language customization
• Unlock - Access geo-restricted or bot-protected websites
• Scrape - Extract structured data from Amazon, LinkedIn, and 100+ domains

---

Installation

pip install langchain-brightdata

Requirements: Python 3.9+

---

Quick Start

1. Get your API key

Sign up at Bright Data and get your API key from the dashboard.

2. Set up authentication

import os
os.environ["BRIGHT_DATA_API_KEY"] = "your-api-key"

Or pass it directly:

from langchain_brightdata import BrightDataSERP
tool = BrightDataSERP(bright_data_api_key="your-api-key")

3. Use with LangChain agents

from langchain_brightdata import BrightDataSERP, BrightDataUnlocker, BrightDataWebScraperAPI
from langchain.agents import initialize_agent, AgentType
from langchain_openai import ChatOpenAI

# Initialize tools
tools = [
    BrightDataSERP(),
    BrightDataUnlocker(),
    BrightDataWebScraperAPI()
]

# Create agent
llm = ChatOpenAI(model="gpt-4")
agent = initialize_agent(tools, llm, agent=AgentType.OPENAI_FUNCTIONS)

# Run
agent.run("Search for the latest AI news and summarize the top result")

---

Tools

BrightDataSERP

Search engine results with geo-targeting and customization.

from langchain_brightdata import BrightDataSERP

serp = BrightDataSERP()

# Simple search
results = serp.invoke("latest AI research")

# Advanced search
results = serp.invoke({
    "query": "electric vehicles",
    "country": "de",
    "language": "de",
    "search_type": "news",
    "results_count": 20
})

Parameters

Parameter	Type	Default	Description
query	str	required	Search query
zone	str	"serp"	Bright Data zone name
search_engine	str	"google"	Search engine (google, bing, yahoo)
country	str	"us"	Two-letter country code
language	str	"en"	Two-letter language code
results_count	int	10	Number of results (max 100)
search_type	str	None	None (web), "isch" (images), "shop", "nws" (news), "jobs"
device_type	str	None	None (desktop), "mobile", "ios", "android"
parse_results	bool	False	Return structured JSON

---

BrightDataUnlocker

Access any public website, bypassing geo-restrictions and bot protection.

from langchain_brightdata import BrightDataUnlocker

unlocker = BrightDataUnlocker()

# Simple access
content = unlocker.invoke("https://example.com")

# With options
content = unlocker.invoke({
    "url": "https://example.com/restricted",
    "country": "gb",
    "data_format": "markdown"
})

Parameters

Parameter	Type	Default	Description
url	str	required	URL to access
zone	str	"unlocker"	Bright Data zone name
country	str	None	Two-letter country code
data_format	str	None	None (HTML), "markdown", "screenshot"

---

BrightDataWebScraperAPI

Extract structured data from popular websites.

from langchain_brightdata import BrightDataWebScraperAPI

scraper = BrightDataWebScraperAPI()

# Amazon product
product = scraper.invoke({
    "url": "https://www.amazon.com/dp/B08L5TNJHG",
    "dataset_type": "amazon_product"
})

# LinkedIn profile
profile = scraper.invoke({
    "url": "https://www.linkedin.com/in/satyanadella/",
    "dataset_type": "linkedin_person_profile"
})

Parameters

Parameter	Type	Default	Description
url	str	required	URL to scrape
dataset_type	str	required	Type of data to extract
zipcode	str	None	Zipcode for location-specific data

Supported Dataset Types

Type	Description
amazon_product	Product details, pricing, specs
amazon_product_reviews	Customer reviews and ratings
linkedin_person_profile	Professional profile data
linkedin_company_profile	Company information

---

Configuration

Zone Configuration

Bright Data uses "zones" to manage different API configurations. You can set the zone at initialization or per-request.

Setting zone at initialization

from langchain_brightdata import BrightDataSERP, BrightDataUnlocker

# SERP with custom zone
serp = BrightDataSERP(
    bright_data_api_key="your-api-key",
    zone="my_serp_zone"
)

# Unlocker with custom zone
unlocker = BrightDataUnlocker(
    bright_data_api_key="your-api-key",
    zone="my_unlocker_zone"
)

Setting zone per-request

# Override zone for a specific request
results = serp.invoke({
    "query": "AI news",
    "zone": "different_zone"
})

Default zones

Tool	Default Zone
BrightDataSERP	serp
BrightDataUnlocker	unlocker

Note: Zone names must match the zones configured in your Bright Data dashboard.

---

Resources

• Bright Data Documentation
• LangChain Tools Guide
• API Reference

---

License

MIT License - see LICENSE for details.