Bright Data Reference, 29 actions

01. Operations

Act on Bright Data from a workflow

Operations are the actions a workflow can take in Bright Data, grouped by category. Each lists its method, parameters, and a template you can drop it into.

Crawl Status

1 operation

Monitor the progress and completion status of ongoing web crawling jobs. Use these operations when you need to track whether a crawl is still running, has finished successfully, or encountered errors during execution.

Action★ Featured

Check Snapshot Status

BRIGHTDATA_GET_SNAPSHOT_STATUS

Monitor the progress of your web crawl job to determine when your collected data is ready for download and analysis.

1 input

Data Filtering

1 operation

Apply filters and refine results from your collected datasets based on specific criteria or parameters. This is essential when you want to narrow down large datasets to only the information relevant to your workflow.

Action

Filter Dataset

BRIGHTDATA_FILTER_DATASET

Refine marketplace datasets by applying custom filters to isolate specific data segments that match your business criteria. This helps you work with smaller, more relevant datasets tailored to your exact needs.

4 input

Locations

2 operations

Retrieve lists of available geographic locations and cities supported by Bright Data's services. Leverage these operations to determine which countries and cities you can target for data collection in your automation workflows.

Action

List Available Cities

BRIGHTDATA_GET_LIST_OF_AVAILABLE_CITIES

Retrieve the list of available cities in a specific country for configuring static proxy endpoints. This helps you select the right geographic location for your proxy network based on your target market or data collection needs.

2 input

Action

List Available Countries

BRIGHTDATA_GET_LIST_OF_AVAILABLE_COUNTRIES

Retrieves a list of all available countries and their ISO codes that you can target for proxy configurations and data collection campaigns.

Scraped Data

1 operation

Retrieve and export the collected data from completed crawling or scraping operations. Use this to access your results in downloadable formats and integrate them into downstream processes or storage systems.

Action★ Featured

Download Snapshot Results

BRIGHTDATA_GET_SNAPSHOT_RESULTS

Retrieves the complete dataset collected from a web scraping job, allowing you to access and download all the data gathered from your crawl for analysis and use.

5 input

Scrapers

1 operation

Explore and identify pre-built scrapers available for different websites and use cases. Browse this catalog to find ready-made solutions that match your data collection needs before creating custom crawling tasks.

Action

List Marketplace Datasets

BRIGHTDATA_DATASET_LIST

Discover and browse all available pre-made data scrapers from Bright Data's marketplace to find structured data sources for your specific business needs.

Search Results

1 operation

Query search engine results and SERP data at scale from multiple locations and search parameters. This operation is valuable when you need to monitor search rankings, competitive intelligence, or gather search-based market research data.

Action★ Featured

Search SERP

BRIGHTDATA_SERP_SEARCH

Retrieve search engine results and competitive intelligence data from major search engines to monitor trends and analyze competitor online visibility. This asynchronous tool returns trackable results for monitoring and reporting.

6 input

Web Access

2 operations

Enable unrestricted access to websites that may have geographic restrictions, IP blocks, or anti-scraping measures. These operations help you bypass access barriers and manage proxy zones to ensure reliable data collection.

Action

List Unlocker Zones

BRIGHTDATA_LIST_WEB_UNLOCKER_ZONES

Retrieve and view all your configured Web Unlocker zones to understand which proxy endpoints are available for web scraping and accessing restricted content.

Action

Scrape Protected URL

BRIGHTDATA_WEB_UNLOCKER

Bypass anti-scraping protections and bot detection to extract content from websites that block automated access, enabling reliable data collection from protected sources.

5 input

Web Crawling

1 operation

Launch and initialize web crawling jobs to systematically extract data from websites. Use this operation to start your data collection processes and specify target URLs, depth, and collection parameters for your automation.

Action★ Featured

Start Site Crawl

BRIGHTDATA_CRAWL_API

Starts a site crawl job to automatically extract content from multiple pages or entire domains, returning a snapshot ID to track and retrieve results. Use this when you need to gather structured data from websites at scale without manual work.

4 input

Ai

19 operations

Action

Create Safe Zone

BRIGHTDATA_CREATE_SAFE_ZONE

Create a durable SERP API or Scraping Browser zone using a fixed safe plan.

5 input

Action

Get Country Cities

BRIGHTDATA_LIST_COUNTRY_CITIES

List cities in a country for account-level geographic selection.

1 input

Action

Get Customer Balance

BRIGHTDATA_GET_CUSTOMER_BALANCE

Get current and pending Bright Data account balances.

Action

Get Dataset Delivery Options

BRIGHTDATA_LIST_DELIVERY_OPTIONS

List settings supported when configuring Bright Data dataset delivery.

Action

Get Dataset Metadata

BRIGHTDATA_GET_DATASET_METADATA

Retrieve field definitions for a Bright Data marketplace dataset.

1 input

Action

Get Deep Lookup Results

BRIGHTDATA_GET_DEEP_LOOKUP_RESULTS

Retrieve enriched records plus available progress, cost, and provider metadata for a completed Deep Lookup request.

1 input

Action

Get Deep Lookup Status

BRIGHTDATA_GET_DEEP_LOOKUP_STATUS

Check a Deep Lookup request's status, progress, cost, and provider metadata.

1 input

Action

Get Destination Type Schema

BRIGHTDATA_GET_DESTINATION_TYPE_SCHEMA

Retrieve the fields required to configure a Bright Data delivery destination.

1 input

Action

Get SERP Results

BRIGHTDATA_GET_SERP_RESULTS

Retrieve JSON or raw results for an asynchronous BRIGHTDATASERPSEARCH request.

3 input

Action

Get Web Archive Search

BRIGHTDATA_GET_WEB_ARCHIVE_SEARCH

Get a Web Archive search's status and its matching-file, dump-size-in-bytes, and dump-cost-in-USD estimates.

1 input

Action

Get Zone Bandwidth

BRIGHTDATA_GET_ZONE_BANDWIDTH

Get uploaded, downloaded, and total byte usage for one zone and date range.

3 input

Action

Get Zone Cost

BRIGHTDATA_GET_ZONE_COST

Get invoice-aligned billed cost and bandwidth for one zone and date range.

3 input

Action

List Scraper Studio Scrapers

BRIGHTDATA_LIST_SCRAPERS

List account-owned Scraper Studio scrapers and discover collector IDs.

1 input

Action

Scrape Data Synchronously

BRIGHTDATA_SCRAPE_DATA_SYNC

Scrape up to 20 input objects synchronously.

6 input

Action

Search Business Records

BRIGHTDATA_SEARCH_BUSINESS_RECORDS

Search public company or professional-profile records synchronously using your Bright Data account.

8 input

Action

Search Dataset Synchronously

BRIGHTDATA_SEARCH_DATASET

Search a supported Bright Data Marketplace dataset through your Bright Data account and return matching records synchronously.

6 input

Action

Search SERP Synchronously

BRIGHTDATA_SEARCH_SERP_SYNC

Search Google, Bing, DuckDuckGo or Yandex and return results synchronously.

6 input

Action

Search Web Archive

BRIGHTDATA_SEARCH_WEB_ARCHIVE

Search Bright Data's Web Archive and estimate matching files, dump size in bytes, and dump cost in USD.

1 input

Action

Start Deep Lookup

BRIGHTDATA_START_DEEP_LOOKUP

Start an asynchronous Deep Lookup research request and return its requestid.

5 input

What now

Use Bright Data in a workflow

Drop a trigger and an action into a template; approve from your phone; the workflow runs.

Browse workflow templates