Skip to main content
Server path: /brightdata | Type: Application | PCID required: Yes Web data collection

Tools

ToolDescription
brightdata_scrape_websiteScrape a website and return the HTML content
brightdata_scrape_serpScrape search engine results pages (SERP)
brightdata_unlock_websiteUnlock and access geo-restricted or blocked websites
brightdata_get_datasetsList available Bright Data datasets
brightdata_get_scraping_jobGet status and results of a scraping job
brightdata_batch_scrapeSubmit a batch of URLs for scraping

brightdata_scrape_website

Scrape a website and return the HTML content Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesThe URL of the website to scrape
datasetIdstringYesBright Data dataset ID for the scraping configuration
waitForSelectorstringNoCSS selector to wait for before scraping
screenshotbooleanNofalseWhether to take a screenshot of the page
formatstringNo"html"Output format for the scraped content

brightdata_scrape_serp

Scrape search engine results pages (SERP) Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesSearch query to scrape results for
searchEnginestringNo"google"Search engine to scrape from
countrystringNo"US"Country code for localized results
languagestringNo"en"Language code for results
numResultsnumberNo10Number of search results to return (1-100)
datasetIdstringYesBright Data dataset ID for SERP scraping

brightdata_unlock_website

Unlock and access geo-restricted or blocked websites Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesThe URL to unlock and access
countrystringNoCountry code to proxy through
userAgentstringNoCustom user agent string
datasetIdstringYesBright Data dataset ID for the unlock configuration

brightdata_get_datasets

List available Bright Data datasets Parameters:
ParameterTypeRequiredDefaultDescription
typestringNoFilter datasets by type

brightdata_get_scraping_job

Get status and results of a scraping job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYesScraping job ID to check
includeResultsbooleanNotrueWhether to include scraping results

brightdata_batch_scrape

Submit a batch of URLs for scraping Parameters:
ParameterTypeRequiredDefaultDescription
urlsstring[]YesArray of URLs to scrape
datasetIdstringYesBright Data dataset ID for batch scraping
webhookstringNoWebhook URL to receive results when complete