Skip to main content

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).
OpenClaw is a self-hosted AI assistant gateway that connects messaging apps like WhatsApp, Telegram, Discord, and iMessage to AI coding agents. It features a plugin system that lets you extend your agent with new tools and capabilities. The Bright Data plugin for OpenClaw brings the full power of Bright Data’s web data infrastructure directly into your OpenClaw agent. Install once, and your agent gains:
  • 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

1

Prerequisites

2

Obtain Your Bright Data API Token

3

Install the Bright Data Plugin

Install the plugin using the OpenClaw CLI:
openclaw plugins install @brightdata/brightdata-plugin
Verify the installation:
openclaw plugins inspect brightdata
You should see the plugin ID brightdata along with all registered tools.
4

Configure Your API Token

Choose one of the following methods to provide your Bright Data API token:
The plugin automatically creates two proxy zones on first use: mcp_unlocker (Web Unlocker) and mcp_browser (Browser API). No manual zone setup is required.
To use existing zones instead:
export BRIGHTDATA_UNLOCKER_ZONE=my_existing_zone
export BRIGHTDATA_BROWSER_ZONE=my_existing_browser_zone
5

Enable the Plugin

Enable the plugin and restart the gateway:
openclaw plugins enable brightdata
openclaw gateway restart
6

Start Using the Tools

Your OpenClaw agent now has access to all 66 Bright Data tools. Try these example prompts:
Search the web
Use the brightdata_search tool to search for "latest AI news" and return the top 5 results.
Scrape a webpage
Use the brightdata_scrape tool on https://example.com and summarize the page in 3 bullets.
Automate a browser
Use brightdata_browser_navigate to open https://example.com, then use brightdata_browser_get_text to return the visible page text.
Get structured data
Use brightdata_amazon_product to get details for https://www.amazon.com/dp/B0D2Q9397Y

Available Tools

ToolDescription
brightdata_searchSearch Google, Bing, or Yandex with geo-targeting. Returns structured results with pagination support.
brightdata_search_batchRun up to 5 search queries in parallel. Partial failures are returned inline.
Parameters for brightdata_search:
ParameterTypeDescription
querystringRequired. Search query
engine"google" | "bing" | "yandex"Search engine (default: google)
countnumberResults to return, 1-10
cursorstringPagination cursor for next page
geo_locationstring2-letter ISO country code (e.g. us, de)

Scrape

ToolDescription
brightdata_scrapeFetch any page through Web Unlocker. Works on bot-protected sites, JS-rendered pages, and geo-restricted content.
brightdata_scrape_batchScrape up to 5 URLs in parallel with the same extraction options.
Parameters for brightdata_scrape:
ParameterTypeDescription
urlstringRequired. HTTP/HTTPS URL to scrape
extractMode"markdown" | "text" | "html"Output format (default: markdown)
maxCharsnumberMaximum 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.
ToolDescription
brightdata_browser_navigateNavigate to a URL with optional country routing
brightdata_browser_snapshotCapture an ARIA snapshot with interactive element refs
brightdata_browser_clickClick an element by its snapshot ref
brightdata_browser_typeType into a field by ref (optional Enter to submit)
brightdata_browser_fill_formFill multiple form fields in a single operation
brightdata_browser_screenshotTake a viewport or full-page screenshot
brightdata_browser_get_htmlGet current page HTML
brightdata_browser_get_textGet current page text content
brightdata_browser_scrollScroll to the bottom of the page
brightdata_browser_scroll_toScroll to a specific element by ref
brightdata_browser_wait_forWait for an element to become visible
brightdata_browser_network_requestsList network requests since page load
brightdata_browser_go_backNavigate back
brightdata_browser_go_forwardNavigate forward

Structured Web Data (50+ Platforms)

Each tool accepts a url or keyword and returns clean, typed JSON. No scraping or parsing required.
ToolData
brightdata_amazon_productProduct details, pricing, specs
brightdata_amazon_product_reviewsCustomer reviews and ratings
brightdata_amazon_product_searchSearch results with rankings
brightdata_walmart_productProduct details and availability
brightdata_walmart_sellerSeller profile and metrics
brightdata_ebay_productListing details and bids
brightdata_homedepot_productsProduct catalog and pricing
brightdata_zara_productsFashion catalog data
brightdata_etsy_productsHandmade and vintage listings
brightdata_bestbuy_productsElectronics catalog and deals
ToolData
brightdata_linkedin_person_profileFull person profile
brightdata_linkedin_company_profileCompany overview and stats
brightdata_linkedin_job_listingsOpen positions with details
brightdata_linkedin_postsPost content and engagement
brightdata_linkedin_people_searchPeople search results
brightdata_crunchbase_companyFunding, investors, founders
brightdata_zoominfo_company_profileCompany intelligence data
Instagram
ToolData
brightdata_instagram_profilesProfile stats and bio
brightdata_instagram_postsPost content and engagement
brightdata_instagram_reelsReel metadata and views
brightdata_instagram_commentsComment threads
Facebook
ToolData
brightdata_facebook_postsPost content and reactions
brightdata_facebook_marketplace_listingsMarketplace items
brightdata_facebook_company_reviewsPage reviews and ratings
brightdata_facebook_eventsEvent details and attendance
TikTok
ToolData
brightdata_tiktok_profilesCreator profile and stats
brightdata_tiktok_postsVideo content and metrics
brightdata_tiktok_shopTikTok Shop product data
brightdata_tiktok_commentsComment threads
X (Twitter)
ToolData
brightdata_x_postsPost content and metrics
brightdata_x_profile_postsProfile post history
YouTube & Reddit
ToolData
brightdata_youtube_profilesChannel stats and info
brightdata_youtube_videosVideo details and metrics
brightdata_youtube_commentsComment threads
brightdata_reddit_postsPost content and scores
ToolData
brightdata_google_maps_reviewsLocation reviews and ratings
brightdata_google_shoppingShopping results and prices
brightdata_google_play_storeApp details and reviews
brightdata_apple_app_storeApp details and reviews
ToolData
brightdata_reuter_newsReuters news articles
brightdata_yahoo_finance_businessCompany financials and news
brightdata_github_repository_fileRepository file contents
ToolData
brightdata_zillow_properties_listingProperty listings and estimates
brightdata_booking_hotel_listingsHotel listings and pricing
ToolData
brightdata_chatgpt_ai_insightsChatGPT responses
brightdata_grok_ai_insightsGrok responses
brightdata_perplexity_ai_insightsPerplexity responses

Web Search Provider Integration

The plugin also registers as an OpenClaw web search provider. To set Bright Data as your default search provider:
openclaw config set tools.web.search.provider brightdata
Once set, any generic web search your agent performs will route through Bright Data’s search infrastructure.

Configuration Reference

All settings can be provided via environment variable or OpenClaw config. Environment variables take priority.
SettingEnvironment VariableOpenClaw Config PathDefault
API TokenBRIGHTDATA_API_TOKENplugins.entries.brightdata.config.webSearch.apiKeyrequired
Base URLBRIGHTDATA_BASE_URLplugins.entries.brightdata.config.webSearch.baseUrlhttps://api.brightdata.com
Unlocker ZoneBRIGHTDATA_UNLOCKER_ZONEplugins.entries.brightdata.config.webSearch.unlockerZonemcp_unlocker
Browser ZoneBRIGHTDATA_BROWSER_ZONEplugins.entries.brightdata.config.webSearch.browserZonemcp_browser
Request Timeout-plugins.entries.brightdata.config.webSearch.timeoutSeconds30s search / 60s scrape
Polling Timeout-plugins.entries.brightdata.config.webSearch.pollingTimeoutSeconds600s

Plugin Management

# Verify installation and loaded tools
openclaw plugins inspect brightdata

# Update to latest version
openclaw plugins update brightdata

# Temporarily disable
openclaw plugins disable brightdata

# Re-enable
openclaw plugins enable brightdata

# Uninstall
openclaw plugins uninstall brightdata

Troubleshooting

Plugin not found after install
  • Run openclaw plugins list to verify the plugin is installed.
  • Check that the plugin ID is brightdata with openclaw plugins inspect brightdata.
  • Run openclaw plugins doctor for diagnostic information.
Tools not registering
  • Ensure the plugin is enabled: openclaw plugins enable brightdata.
  • Restart the gateway: openclaw gateway restart.
Authentication errors
  • Verify your API token is set correctly via env var or config.
  • Check that the token has not expired in your Bright Data dashboard.
Zone creation failures
  • The plugin auto-creates mcp_unlocker and mcp_browser zones on first use.
  • If auto-creation fails, create the zones manually in your Bright Data dashboard and set them via environment variables.

Additional Resources