Documentation Index
Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
Use this file to discover all available pages before exploring further.
Building an AI startup?
You might be eligible for our Startup Program. Get fully funded access to the infrastructure you’re reading about right now (up to $20K value).
- Real-time web search via Google, Bing, and Yandex with geo-targeting
- Bot-bypass scraping through Web Unlocker, which handles CAPTCHAs, JS rendering, and rate limits automatically
- Full browser automation via a real Chromium instance routed through Bright Data’s residential proxy network
- 50+ structured data tools for Amazon, LinkedIn, Instagram, TikTok, YouTube, Reddit, and more
The plugin registers 66 tools across five categories: search, scrape, batch operations, browser automation, and structured web data.
Steps to Get Started
Prerequisites
- OpenClaw installed and running
- A Bright Data account with an API key
- Node.js 22+ (managed by OpenClaw)
Obtain Your Bright Data API Key
- Log in to your Bright Data dashboard.
- Go to Account Settings.
- Generate an API key if you haven’t already done so.
Install the Bright Data Plugin
Install the plugin using the OpenClaw CLI:Verify the installation:You should see the plugin ID
brightdata along with all registered tools.Configure Your API Key
Choose one of the following methods to provide your Bright Data API key:To use existing zones instead:
- Environment Variable (recommended for local dev)
- OpenClaw Config (recommended for persistent setups)
Enable the Plugin
Enable the plugin and restart the gateway:
If the plugin tools are not being exposed to your agent, you may need to explicitly allow plugin tools:
Available Tools
Search
| Tool | Description |
|---|---|
brightdata_search | Search Google, Bing, or Yandex with geo-targeting. Returns structured results with pagination support. |
brightdata_search_batch | Run up to 5 search queries in parallel. Partial failures are returned inline. |
brightdata_search:
| Parameter | Type | Description |
|---|---|---|
query | string | Required. Search query |
engine | "google" | "bing" | "yandex" | Search engine (default: google) |
count | number | Results to return, 1-10 |
cursor | string | Pagination cursor for next page |
geo_location | string | 2-letter ISO country code (e.g. us, de) |
Scrape
| Tool | Description |
|---|---|
brightdata_scrape | Fetch any page through Web Unlocker. Works on bot-protected sites, JS-rendered pages, and geo-restricted content. |
brightdata_scrape_batch | Scrape up to 5 URLs in parallel with the same extraction options. |
brightdata_scrape:
| Parameter | Type | Description |
|---|---|---|
url | string | Required. HTTP/HTTPS URL to scrape |
extractMode | "markdown" | "text" | "html" | Output format (default: markdown) |
maxChars | number | Maximum characters to return (min: 100) |
Browser Automation
Full Chromium browser control routed through Bright Data’s residential proxy network. Sessions idle-timeout after 10 minutes.| Tool | Description |
|---|---|
brightdata_browser_navigate | Navigate to a URL with optional country routing |
brightdata_browser_snapshot | Capture an ARIA snapshot with interactive element refs |
brightdata_browser_click | Click an element by its snapshot ref |
brightdata_browser_type | Type into a field by ref (optional Enter to submit) |
brightdata_browser_fill_form | Fill multiple form fields in a single operation |
brightdata_browser_screenshot | Take a viewport or full-page screenshot |
brightdata_browser_get_html | Get current page HTML |
brightdata_browser_get_text | Get current page text content |
brightdata_browser_scroll | Scroll to the bottom of the page |
brightdata_browser_scroll_to | Scroll to a specific element by ref |
brightdata_browser_wait_for | Wait for an element to become visible |
brightdata_browser_network_requests | List network requests since page load |
brightdata_browser_go_back | Navigate back |
brightdata_browser_go_forward | Navigate forward |
Structured Web Data (50+ Platforms)
Each tool accepts aurl or keyword and returns clean, typed JSON. No scraping or parsing required.
E-commerce (10 tools)
E-commerce (10 tools)
| Tool | Data |
|---|---|
brightdata_amazon_product | Product details, pricing, specs |
brightdata_amazon_product_reviews | Customer reviews and ratings |
brightdata_amazon_product_search | Search results with rankings |
brightdata_walmart_product | Product details and availability |
brightdata_walmart_seller | Seller profile and metrics |
brightdata_ebay_product | Listing details and bids |
brightdata_homedepot_products | Product catalog and pricing |
brightdata_zara_products | Fashion catalog data |
brightdata_etsy_products | Handmade and vintage listings |
brightdata_bestbuy_products | Electronics catalog and deals |
Professional Networks (7 tools)
Professional Networks (7 tools)
| Tool | Data |
|---|---|
brightdata_linkedin_person_profile | Full person profile |
brightdata_linkedin_company_profile | Company overview and stats |
brightdata_linkedin_job_listings | Open positions with details |
brightdata_linkedin_posts | Post content and engagement |
brightdata_linkedin_people_search | People search results |
brightdata_crunchbase_company | Funding, investors, founders |
brightdata_zoominfo_company_profile | Company intelligence data |
Social Media (17 tools)
Social Media (17 tools)
Maps, Shopping & Apps (4 tools)
Maps, Shopping & Apps (4 tools)
| Tool | Data |
|---|---|
brightdata_google_maps_reviews | Location reviews and ratings |
brightdata_google_shopping | Shopping results and prices |
brightdata_google_play_store | App details and reviews |
brightdata_apple_app_store | App details and reviews |
Finance, News & Code (3 tools)
Finance, News & Code (3 tools)
| Tool | Data |
|---|---|
brightdata_yahoo_finance_business | Company financials and news |
brightdata_github_repository_file | Repository file contents |
Real Estate & Travel (2 tools)
Real Estate & Travel (2 tools)
| Tool | Data |
|---|---|
brightdata_zillow_properties_listing | Property listings and estimates |
brightdata_booking_hotel_listings | Hotel listings and pricing |
AI Insights (3 tools)
AI Insights (3 tools)
| Tool | Data |
|---|---|
brightdata_chatgpt_ai_insights | ChatGPT responses |
brightdata_grok_ai_insights | Grok responses |
brightdata_perplexity_ai_insights | Perplexity responses |
Web Search Provider Integration
The plugin also registers as an OpenClaw web search provider. To set Bright Data as your default search provider:Configuration Reference
All settings can be provided via environment variable or OpenClaw config. Environment variables take priority.| Setting | Environment Variable | OpenClaw Config Path | Default |
|---|---|---|---|
| API Key | BRIGHTDATA_API_TOKEN | plugins.entries.brightdata.config.webSearch.apiKey | required |
| Base URL | BRIGHTDATA_BASE_URL | plugins.entries.brightdata.config.webSearch.baseUrl | https://api.brightdata.com |
| Unlocker Zone | BRIGHTDATA_UNLOCKER_ZONE | plugins.entries.brightdata.config.webSearch.unlockerZone | mcp_unlocker |
| Browser Zone | BRIGHTDATA_BROWSER_ZONE | plugins.entries.brightdata.config.webSearch.browserZone | mcp_browser |
| Request Timeout | - | plugins.entries.brightdata.config.webSearch.timeoutSeconds | 30s search / 60s scrape |
| Polling Timeout | - | plugins.entries.brightdata.config.webSearch.pollingTimeoutSeconds | 600s |
Plugin Management
Troubleshooting
Plugin not found after install- Run
openclaw plugins listto verify the plugin is installed. - Check that the plugin ID is
brightdatawithopenclaw plugins inspect brightdata. - Run
openclaw plugins doctorfor diagnostic information.
- Ensure the plugin is enabled:
openclaw plugins enable brightdata. - Restart the gateway:
openclaw gateway restart.
- Verify your API key is set correctly via env var or config.
- Check that the token has not expired in your Bright Data dashboard.
- The plugin auto-creates
mcp_unlockerandmcp_browserzones on first use. - If auto-creation fails, create the zones manually in your Bright Data dashboard and set them via environment variables.
brightdata_instagram_profilesbrightdata_instagram_postsbrightdata_instagram_reelsbrightdata_instagram_commentsbrightdata_facebook_postsbrightdata_facebook_marketplace_listingsbrightdata_facebook_company_reviewsbrightdata_facebook_eventsbrightdata_tiktok_profilesbrightdata_tiktok_postsbrightdata_tiktok_shopbrightdata_tiktok_commentsbrightdata_x_postsbrightdata_x_profile_postsbrightdata_youtube_profilesbrightdata_youtube_videosbrightdata_youtube_commentsbrightdata_reddit_posts