Skip to main content
Bright Data logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 167
  • Triggers: 0
  • Slug: BRIGHTDATA
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: BRIGHTDATA_CRAWL_APIStart an asynchronous dataset or site crawl. Poll the returned snapshot_id with BRIGHTDATA_GET_SNAPSHOT_STATUS, then download it with BRIGHTDATA_GET_SNAPSHOT_RESULTS.

Input Parameters

array
required
Crawler input objects. Required fields vary by dataset; URL crawlers commonly require url, while discovery crawlers may require keywords or other documented fields.
string
required
Dataset or crawler ID to run.
boolean
Whether to include an error report with the results.
string
Pipe-separated output fields to include, such as ‘url|title’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_CREATE_SAFE_ZONECreate a durable SERP API or Scraping Browser zone using a fixed safe plan. This Admin/Ops operation changes account infrastructure and may incur charges. If Bright Data returns HTTP 429, retry after the Retry-After delay when present.

Input Parameters

string
required
Name for the new Bright Data zone.
string
Lowercase ISO 3166-1 alpha-2 country code, or ‘any’. Uppercase input is normalized.
string ("serp" | "scraping_browser")
required
Safe product to provision: SERP API or Scraping Browser.
boolean
Allow custom request headers in the new zone.
boolean
For SERP zones, disable Bright Data captcha solving. Ignored for Scraping Browser zones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_DATASET_LISTList pre-built datasets in Bright Data’s marketplace for structured scraping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_FILTER_DATASETCreate a billable filtered marketplace-dataset snapshot. Use records_limit to cap the number of included records.

Input Parameters

array
Optional uploaded CSV or JSON files containing filter values.
object
required
Filter criteria object. Basic filter: {“name”: “field_name”, “operator”: ”=”, “value”: “search_term”}. Combine filters: {“operator”: “and”, “filters”: [{…}, {…}]}. Supported operators: ’=’, ’!=’, ’<’, ’<=’, ’>’, ’>=’, ‘in’, ‘not_in’, ‘includes’, ‘not_includes’, ‘array_includes’, ‘not_array_includes’, ‘is_null’, ‘is_not_null’. Max nesting depth: 3.
string
required
ID of the dataset to filter.
integer
Optional maximum number of records to include in the snapshot, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_CUSTOMER_BALANCEGet current and pending Bright Data account balances. This endpoint requires an API key with Admin permission. If HTTP 429 is returned, retry after the Retry-After delay when present.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_DATASET_METADATARetrieve field definitions for a Bright Data marketplace dataset.

Input Parameters

string
required
Dataset ID returned by BRIGHTDATA_DATASET_LIST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_DEEP_LOOKUP_RESULTSRetrieve enriched records plus available progress, cost, and provider metadata for a completed Deep Lookup request. Each record preserves the lookup’s dynamic columns. If the API returns HTTP 429, retry according to Retry-After when present rather than using a fixed request rate.

Input Parameters

string
required
Completed Deep Lookup request_id whose records should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_DEEP_LOOKUP_STATUSCheck a Deep Lookup request’s status, progress, cost, and provider metadata. Poll until completion before retrieving results. If the API returns HTTP 429, retry according to Retry-After when present rather than using a fixed request rate.

Input Parameters

string
required
Deep Lookup request_id returned when the lookup was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_DESTINATION_TYPE_SCHEMARetrieve the fields required to configure a Bright Data delivery destination.

Input Parameters

string ("api_pull" | "webhook" | "email" | "gcs" | "gcp_pubsub" | "s3" | "snowflake" | "ali_oss" | "sftp" | "azure")
required
Delivery destination whose provider-defined configuration schema to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_LIST_OF_AVAILABLE_CITIESList static-network cities available for a country and proxy pool type.

Input Parameters

string
required
ISO 3166-1 alpha-2 country code to list available cities for.
string ("dc" | "static_res")
Type of static proxy pool. ‘dc’ for datacenter, ‘static_res’ for residential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_LIST_OF_AVAILABLE_COUNTRIESList country codes available for each static proxy zone type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_SERP_RESULTSRetrieve JSON or raw results for an asynchronous BRIGHTDATA_SERP_SEARCH request. A 202 response means the job is still pending and should be retried later.

Input Parameters

string
Optional SERP zone name when the provider requires it for result retrieval.
string
required
Async SERP response ID returned by BRIGHTDATA_SERP_SEARCH.
string ("json" | "raw")
Expected result format. Match the format used in BRIGHTDATA_SERP_SEARCH.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_SNAPSHOT_RESULTSDownload a completed dataset snapshot. A pending response contains no result data; poll BRIGHTDATA_GET_SNAPSHOT_STATUS before retrying.

Input Parameters

integer
Which batch part to download (starts from 1). Use with ‘batch_size’ parameter.
string ("json" | "csv" | "ndjson" | "jsonl")
Desired output format. Options: json, csv, ndjson (newline-delimited JSON), or jsonl (JSON Lines).
boolean
Whether to compress the result using gzip.
integer
Divide snapshot into batches of this size (minimum 1000 records). Use with ‘part’ parameter. For large snapshots, always paginate using both batch_size and part together; skipping pagination can silently drop records or exceed response limits.
string
required
Identifier of the snapshot to fetch results for. This is the snapshot_id returned by the Trigger Site Crawl (CRAWL_API) action, typically in the format ‘s_xxxxxxxxxxxxx’. IDs expire after some time; stale or invalid IDs return empty or error responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_SNAPSHOT_STATUSCheck whether a dataset snapshot is running, ready, or failed before downloading it.

Input Parameters

string
required
Identifier of the snapshot to check. This is the snapshot_id returned by the Trigger Site Crawl (CRAWL_API) action, typically in the format ‘s_xxxxxxxxxxxxx’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_WEB_ARCHIVE_SEARCHGet a Web Archive search’s status and its matching-file, dump-size-in-bytes, and dump-cost-in-USD estimates. The search only estimates a dump and does not create a billable dump. Up to 100 searches that have not had a dump triggered are allowed per day.

Input Parameters

string
required
Archive search identifier returned by BRIGHTDATA_SEARCH_WEB_ARCHIVE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_ZONE_BANDWIDTHGet uploaded, downloaded, and total byte usage for one zone and date range.

Input Parameters

string
required
Zone name to report.
string
Optional ISO 8601 end date or timestamp for the usage window.
string
Optional ISO 8601 start date or timestamp for the usage window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_GET_ZONE_COSTGet invoice-aligned billed cost and bandwidth for one zone and date range. The to_date boundary is exclusive.

Input Parameters

string
required
Zone name to report.
string
Exclusive end date in ISO YYYY-MM-DD format; use the first day after the desired period.
string
Inclusive start date in ISO YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_LIST_COUNTRY_CITIESList cities in a country for account-level geographic selection. For static datacenter or residential proxy-pool inventory, use BRIGHTDATA_GET_LIST_OF_AVAILABLE_CITIES instead.

Input Parameters

string
required
Two-letter country code whose cities should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_LIST_DELIVERY_OPTIONSList settings supported when configuring Bright Data dataset delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_LIST_SCRAPERSList account-owned Scraper Studio scrapers and discover collector IDs.

Input Parameters

Optional term used to filter scrapers by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_LIST_WEB_UNLOCKER_ZONESList configured Web Unlocker zones and their types for protected-URL scraping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AE_COM_COMPLETE_PRODUCTSCollect AE.com - Complete Products. Supports collect_by_url, discover_by_category. Returns structured product_name, brand, description, initial_price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_AMERICAN_EAGLE_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for AE.com - Complete Products on ae.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AGODA_LISTINGS_SEARCHCollect Agoda Listings Search. Supports collect_by_url. Returns structured url, location, check_in, check_out data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires adults, check_in, check_out, location, url; accepted optional fields: children, country, currency.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AGODA_PROPERTIES_LISTINGSCollect Agoda Properties Listings. Supports collect_by_url, discover_by_country, discover_by_url. Returns structured url, hotel_id, title, location data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_country" | "discover_by_url")
required
Bright Data collection method for Agoda Properties Listings on agoda.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_country requires country; accepted optional fields: none. discover_by_url requires url; accepted optional fields: country.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AGODA_PROPERTIES_LISTINGS_WITH_PRICINGCollect Agoda Properties Listings with Pricing. Supports collect_by_url, discover_by_search_input. Returns structured url, listing_id, title, location data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_search_input")
required
Bright Data collection method for Agoda Properties Listings with Pricing on agoda.com.
array
required
collect_by_url requires url; accepted optional fields: country. discover_by_search_input requires adults, check_in, check_out, location, url; accepted optional fields: children, country, currency, first_listing_only.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AGODA_REVIEWSCollect Agoda Reviews. Supports collect_by_url. Returns structured review_id, url, hotel_name, hotel_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: max_reviews, reviews_to_not_include, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMAZON_PRODUCTSCollect Amazon products by URL with optional ASIN metadata, or discover them by best-seller/category URL, keyword, or UPC, returning product and price data. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_best_sellers_url" | "discover_by_category_url" | "discover_by_keyword" | "discover_by_upc")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: all_variations, asin, language, origin_url, zipcode. discover_by_best_sellers_url requires category_url; accepted optional fields: all_variations, collect_child_categories, zipcode. discover_by_category_url requires url; accepted optional fields: all_variation, sort_by, zipcode. discover_by_keyword requires keyword; accepted optional fields: all_variations, zipcode. discover_by_upc requires none; accepted optional fields: all_variations, upc, zipcode.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMAZON_PRODUCT_SEARCHCollect structured Amazon products search data from amazon.com, including asin, url, name, sponsored, initial_price. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires keyword, url; accepted optional fields: pages_to_search.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMAZON_PRODUCTS_GLOBALCollect global Amazon products by URL or discover them by best-seller, brand, category, keyword/domain, or seller, returning product and price data. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_best_sellers_url" | "discover_by_brand" | "discover_by_category_url" | "discover_by_keywords" | "discover_by_seller")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: bought_past_month, zipcode. discover_by_best_sellers_url requires url; accepted optional fields: collect_child_categories. discover_by_brand requires url; accepted optional fields: none. discover_by_category_url requires url; accepted optional fields: bought_past_month_only, get_sponsored, sort_by, zipcode. discover_by_keywords requires domain, keywords; accepted optional fields: pages_to_search, zipcode. discover_by_seller requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMAZON_REVIEWSCollect structured Amazon Reviews data from amazon.com, including url, product_name, product_rating, product_rating_object, product_rating_max. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: max_reviews, reviews_to_not_include, variation_specific.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMAZON_SELLERSCollect structured Amazon sellers info data from amazon.com, including seller_id, url, seller_name, description, detailed_info. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_AMERICAN_EAGLE_PRODUCTS_UNIFIED_SCHEMACollect American Eagle. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_AE_COM_COMPLETE_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for American Eagle on ae.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_APPLE_APP_STORECollect Apple App Store. Supports collect_by_url. Returns structured url, title, sub_title, developer data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_APPLE_APP_STORE_REVIEWSCollect Apple App Store reviews . Supports collect_by_url. Returns structured url, review_id, review_title, review_rating data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ASHLEY_FURNITURE_PRODUCTSCollect Ashleyfurniture - Products. Supports collect_by_url, discover_by_category, discover_by_sitemap. Returns structured product_name, brand, initial_price, final_price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_ASHLEY_FURNITURE_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_sitemap")
required
Bright Data collection method for Ashleyfurniture - Products on ashleyfurniture.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none. discover_by_sitemap requires none; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ASHLEY_FURNITURE_PRODUCTS_UNIFIED_SCHEMACollect Ashley Furniture. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_ASHLEY_FURNITURE_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Ashley Furniture on ashleyfurniture.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BEST_BUY_PRODUCTSCollect Best Buy products. Supports collect_by_url, discover_by_keywords. Returns structured url, product_id, title, images data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keywords")
required
Bright Data collection method for Best Buy products on bestbuy.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_keywords requires keywords; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BEST_BUY_REVIEWSCollect Best Buy Reviews. Supports collect_by_url. Returns structured url, product_name, product_id, sku data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: days_back, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BOOKING_HOTEL_LISTINGSCollect Booking Hotel Listings . Supports collect_by_url. Returns structured url, hotel_id, title, location data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BOOKING_HOTEL_LISTINGS_WITH_PRICINGCollect Booking Hotel Listings with Pricing. Supports collect_by_url, discover_by_search_input. Returns structured url, listing_id, title, location data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_search_input")
required
Bright Data collection method for Booking Hotel Listings with Pricing on booking.com.
array
required
collect_by_url requires url; accepted optional fields: country. discover_by_search_input requires adults, check_in, check_out, location, rooms, url; accepted optional fields: children, country, currency, first_listing_only.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BOOKING_LISTINGS_SEARCHCollect Booking Listings Search. Supports collect_by_url. Returns structured url, location, check_in, check_out data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires adults, check_in, check_out, location, rooms, url; accepted optional fields: children, country, currency, property_type.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_BOOKING_REVIEWSCollect Booking Reviews. Supports collect_by_url. Returns structured hotel_booking_website, hotel_name, hotel_location, hotel_rating data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: max_reviews, reviews_to_not_include, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_CHATGPT_SEARCHCollect ChatGPT Search. Supports collect_by_url. Returns structured url, prompt, answer_html, answer_text data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires prompt, url; accepted optional fields: additional_prompt, country, geolocation, index, require_sources, web_search.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_COSTCO_PRODUCTSCollect Costco products. Supports collect_by_url. Returns structured url, item_id, variant_id, gtin data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_COSTCO_REVIEWSCollect Costco Reviews. Supports collect_by_url. Returns structured url, product_name, product_id, item_number data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: days_back, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_CRATE_AND_BARREL_PRODUCTSCollect Crateandbarrel - Products. Supports collect_by_url, discover_by_category. Returns structured product_name, brand, description, initial_price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_CRATE_AND_BARREL_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for Crateandbarrel - Products on crateandbarrel.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_CRATE_AND_BARREL_PRODUCTS_UNIFIED_SCHEMACollect Crateandbarrel - Products. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_CRATE_AND_BARREL_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Crateandbarrel - Products on crateandbarrel.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_CREATIVE_COMMONS_3D_MODELSCollect Creative Commons 3D Models. Supports collect_by_url. Returns structured url, id, domain, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_CREATIVE_COMMONS_IMAGESCollect Creative Commons Images. Supports collect_by_url. Returns structured url, title, description, image_url data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: keyword.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_DATA_SYNCScrape up to 20 input objects synchronously. Bright Data bills per returned record. Requests exceeding the one-minute synchronous limit fall back to an asynchronous snapshot; use the returned snapshot ID after retry_after seconds. On HTTP 429, honor the provider’s Retry-After header before retrying.

Input Parameters

array
required
One to 20 input objects accepted by the selected dataset. Each object may contain any fields supported by that scraper.
string ("json" | "csv" | "ndjson")
Response format. Bright Data defaults to JSON when omitted.
string
required
Dataset ID whose scraper should process the inputs.
boolean
Whether the response should include an errors report.
integer
Maximum records returned for each input, primarily for discovery requests with open-ended results.
string
Pipe-separated output fields to return, such as ‘title|final_price|url’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_DIOR_PRODUCTSCollect Dior - Products. Supports collect_by_url, discover_by_category. Returns structured product_name, description, country, currency data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_DIOR_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for Dior - Products on dior.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_DIOR_PRODUCTS_UNIFIED_SCHEMACollect Dior Products Unified Schema. Supports collect_by_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_DIOR_PRODUCTS action for its richer site-specific schema.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_COMMENTSCollect structured Facebook - Comments data from facebook.com, including url, post_id, post_url, comment_id, user_name. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: comments_sort, get_all_replies, include_comments, limit_records.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_COMPANY_REVIEWSCollect Facebook Company Reviews. Supports collect_by_url. Returns structured company_name, company_id, company_url, url data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: end_date, num_of_reviews, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_EVENTSCollect Facebook Events. Supports collect_by_url, discover_by_url, discover_by_venue. Returns structured event_id, url, main_image, event_date data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_url" | "discover_by_venue")
required
Bright Data collection method for Facebook Events on facebook.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_url requires url; accepted optional fields: none. discover_by_venue requires url; accepted optional fields: upcoming_events_only.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_GROUP_POSTSCollect structured Facebook - Posts by group URL data from facebook.com, including url, post_id, user_url, user_username_raw, content. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: end_date, num_of_posts, posts_to_not_include, start_date, user_to_not_include.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_MARKETPLACECollect Facebook Marketplace. Supports collect_by_url, discover_by_keyword, discover_by_url. Returns structured url, title, initial_price, final_price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword" | "discover_by_url")
required
Bright Data collection method for Facebook Marketplace on facebook.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_keyword requires city, keyword; accepted optional fields: date_listed, radius. discover_by_url requires url; accepted optional fields: country.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_PAGE_POSTSCollect structured Facebook - Pages Posts by Profile URL data from facebook.com, including url, post_id, user_url, user_username_raw, content. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: country, end_date, include_profile_data, num_of_posts, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_PAGES_AND_PROFILESCollect Facebook pages and public profiles with the combined page/profile dataset, including entity type and page-oriented fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_POSTS_BY_POST_URLCollect Facebook - Posts by post URL. Supports collect_by_url. Returns structured url, post_id, user_url, user_username_raw data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_PROFILESCollect Facebook profile URLs with the profile-only dataset. Use when page records and the combined page/profile schema are not needed. Supports collect_by_url. Returns structured url, name, id, profile_photo data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FACEBOOK_REELS_BY_PROFILE_URLCollect Facebook - Reels by profile URL. Supports collect_by_url. Returns structured url, post_id, user_url, user_username_raw data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: end_date, num_of_posts, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FALABELLA_COM_REVIEWSCollect Falabella.com - Reviews. Supports collect_by_url, discover_by_sku. Returns structured rootdomain, sku, variant_sku, review_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_sku")
required
Bright Data collection method for Falabella.com - Reviews on falabella.com.
array
required
collect_by_url requires sku, url; accepted optional fields: none. discover_by_sku requires sku; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FALABELLA_COM_SEARCHCollect Falabella.com - Search. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured rank, page, sku, variant_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Falabella.com - Search on falabella.com.
array
required
collect_by_url requires url; accepted optional fields: page. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FALABELLA_PRODUCTSCollect Falabella.com. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured url, star_rating_distribution, is_promo, seller_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Falabella.com on falabella.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FLIPKART_COM_SEARCHCollect Flipkart.com - Search. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured rank, page, sku, variant_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Flipkart.com - Search on flipkart.com.
array
required
collect_by_url requires url; accepted optional fields: page. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FLIPKART_PRODUCTSCollect Flipkart.com. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured sku, variant_id, url, rootdomain data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_FLIPKART_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Flipkart.com on flipkart.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FLIPKART_PRODUCTS_UNIFIED_SCHEMACollect Flipkart Products unified schema. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_FLIPKART_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Flipkart Products unified schema on flipkart.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_FLIPKART_REVIEWSCollect Flipkart - Reviews. Supports collect_by_url, discover_by_sku. Returns structured rootdomain, sku, variant_sku, review_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_sku")
required
Bright Data collection method for Flipkart - Reviews on flipkart.com.
array
required
collect_by_url requires sku, url; accepted optional fields: days_back, pid, sort_by. discover_by_sku requires sku; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GLASSDOOR_COMPANIES_OVERVIEW_INFORMATIONCollect Glassdoor companies overview information. Supports collect_by_url, discover_by_input_filter, discover_by_keyword, discover_by_search_url. Returns structured id, company, ratings_overall, details_size data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_input_filter" | "discover_by_keyword" | "discover_by_search_url")
required
Bright Data collection method for Glassdoor companies overview information on glassdoor.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_input_filter requires none; accepted optional fields: job_title, industries, location. discover_by_keyword requires max_search_results, search_url; accepted optional fields: none. discover_by_search_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GLASSDOOR_COMPANIES_REVIEWSCollect Glassdoor companies reviews. Supports collect_by_url. Returns structured overview_id, review_id, review_url, rating_date data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires days, url; accepted optional fields: original_url.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GLASSDOOR_JOBSCollect Glassdoor job listings information. Supports collect_by_url, discover_by_keyword, discover_by_url. Returns structured url, company_url_overview, company_name, company_rating data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword" | "discover_by_url")
required
Bright Data collection method for Glassdoor job listings information on glassdoor.com.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_keyword requires keyword, location; accepted optional fields: country, date_posted. discover_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_AI_MODE_SEARCHCollect Google AI Mode Search. Supports collect_by_url. Returns structured url, prompt, answer_html, answer_text data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires prompt, url; accepted optional fields: country, hl, index.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_FLIGHTSCollect Google Flights. Supports collect_by_url, discover_by_input_filters. Returns structured url, itinerary_id, search, pricing data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_input_filters")
required
Bright Data collection method for Google Flights on google.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_input_filters requires adults, destination, origin, trip_type; accepted optional fields: cabin, children, country, currency, departure, infants_in_seat, infants_on_lap, language, return.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_HOTELSCollect Google Hotels. Supports collect_by_url, discover_by_filter_url, discover_by_search. Returns structured url, hotel_id, hotel_name, rating data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_filter_url" | "discover_by_search")
required
Bright Data collection method for Google Hotels on google.com.
array
required
collect_by_url requires url; accepted optional fields: country. discover_by_filter_url requires url; accepted optional fields: country, currency. discover_by_search requires check_in_date, check_out_date, guest_number, search_term; accepted optional fields: accommodation_type, country, currency, property_type, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_IMAGESCollect Google Images. Supports collect_by_url. Returns structured url, search_input, license, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_MAPS_IMAGESCollect Google Maps place images. Use for image records rather than full place details or reviews. Supports collect_by_url. Returns structured place_id, url, country, name data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_MAPS_PLACESCollect Google Maps place URLs or discover places by keyword and location. Returns full place details; use the reviews or images datasets for those specialized resources. Supports collect_by_url, discover_by_cid, discover_by_location, discover_by_place_id. Returns structured place_id, url, country, name data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_cid" | "discover_by_location" | "discover_by_place_id")
required
Bright Data collection method for Google Maps full information on google.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_cid requires CID; accepted optional fields: none. discover_by_location requires country, keyword; accepted optional fields: lat, long, zoom_level. discover_by_place_id requires place_id; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_MAPS_REVIEWSCollect Google Maps place reviews or discover reviews from place URLs. Use for review records rather than full place details. Supports collect_by_url. Returns structured url, place_id, place_name, country data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: days_limit, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_PLAY_STORECollect Google Play Store. Supports collect_by_url. Returns structured url, title, developer, monetization_features data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: country.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_PLAY_STORE_REVIEWSCollect Google Play Store reviews. Supports collect_by_url. Returns structured url, review_id, reviewer_name, review_date data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: country, end_date, language, num_of_reviews, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_SERP_100_RESULTSCollect Google SERP - 100 Results. Supports collect_by_url. Returns structured url, keyword, general, related data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: brd_mobile, collapse_aio, country, end_page, include_paginated_html, index, keyword, language, nfpr, start_page, tbm, tbs, udm_web, uule.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_SHOPPINGCollect Google Shopping product pages or discover products by keyword with the general Google Shopping dataset. Supports collect_by_url, discover_by_keyword. Returns structured url, product_id, title, product_description data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword")
required
Bright Data collection method for Google Shopping on google.com.
array
required
collect_by_url requires url; accepted optional fields: country. discover_by_keyword requires country, keyword; accepted optional fields: deep_discovery.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_GOOGLE_SHOPPING_PRODUCTS_SEARCH_USCollect US Google Shopping search-result URLs with the US search schema. Use for an existing US results URL, not general keyword discovery. Supports collect_by_url. Returns structured url, product_id, title, final_price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_HM_PRODUCTSCollect H&M - Products. Supports collect_by_url, discover_by_category. Returns structured category_tree, color, country_code, county_of_origin data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_HM_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for H&M - Products on www2.hm.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_HM_PRODUCTS_UNIFIED_SCHEMACollect H&M products. Supports collect_by_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_HM_PRODUCTS action for its richer site-specific schema.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_IKEA_PRODUCTSCollect Ikea - Products. Supports collect_by_url, discover_by_category. Returns structured description, in_stock, color, size data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_IKEA_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for Ikea - Products on ikea.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_IKEA_PRODUCTS_UNIFIED_SCHEMACollect Ikea products unified schema. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_IKEA_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Ikea products unified schema on ikea.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INDEED_COMPANIES_INFOCollect Indeed companies info. Supports collect_by_url, discover_by_company_list, discover_by_industry_and_state, discover_by_keyword. Returns structured name, description, url, work_happiness data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_company_list" | "discover_by_industry_and_state" | "discover_by_keyword")
required
Bright Data collection method for Indeed companies info on indeed.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_company_list requires url; accepted optional fields: none. discover_by_industry_and_state requires industry; accepted optional fields: state. discover_by_keyword requires keyword; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INDEED_JOBSCollect Indeed job listings information. Supports collect_by_url, discover_by_keyword, discover_by_url. Returns structured jobid, company_name, date_posted_parsed, job_title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword" | "discover_by_url")
required
Bright Data collection method for Indeed job listings information on indeed.com.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_keyword requires country, domain, keyword_search, location; accepted optional fields: date_posted, location_radius, pay, posted_by. discover_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTACART_PRODUCTSCollect Instacart products. Supports collect_by_url, discover_by_category_url. Returns structured url, product_id, product_name, brand data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_INSTACART_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Instacart products on instacart.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTACART_PRODUCTS_UNIFIED_SCHEMACollect Instacart Products unified schema. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, title, description data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_INSTACART_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Instacart Products unified schema on instacart.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTAGRAM_COMMENTSCollect Instagram comments with commenter, text, date, likes, replies, hashtags, tagged users, and source-post details. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: exclude_comments, include_comments.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTAGRAM_POSTSCollect Instagram posts or discover posts from a profile, returning captions, hashtags, media, engagement, dates, location, and comments. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_url")
required
Collect one post or discover posts from a profile URL.
array
required
collect_by_url requires url; accepted optional fields: country, discovery_input. discover_by_url requires url; accepted optional fields: end_date, num_of_posts, post_type, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTAGRAM_PROFILESCollect Instagram profiles by URL or discover them by username, returning biography, audience, verification, links, posts, and profile image. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_user_name")
required
Collect by profile URL or discover by username.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_user_name requires user_name; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_INSTAGRAM_REELSCollect Instagram reels or discover reels from profiles, returning captions, hashtags, media, dates, engagement, play counts, and comments. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_url" | "discover_by_url_all_reels")
required
Collection or profile discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: country_code, followers, following, posts_count, video_play_count, views. discover_by_url requires url; accepted optional fields: all_reels, country_code, end_date, num_of_posts, posts_to_not_include, start_date. discover_by_url_all_reels requires url; accepted optional fields: country_code, end_date, num_of_posts, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_KOHLS_COM_REVIEWSCollect Kohls.com - Reviews. Supports collect_by_url, discover_by_sku. Returns structured url, rootdomain, sku, variant_sku data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_sku")
required
Bright Data collection method for Kohls.com - Reviews on kohls.com.
array
required
collect_by_url requires sku, url; accepted optional fields: none. discover_by_sku requires sku; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_KOHLS_PRODUCTSCollect Kohls.com. Supports collect_by_url, discover_by_category_url, discover_by_keyword. Returns structured url, star_rating_distribution, quantity_sold, views data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_KOHLS_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category_url" | "discover_by_keyword")
required
Bright Data collection method for Kohls.com on kohls.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category_url requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_KOHLS_PRODUCTS_UNIFIED_SCHEMACollect Kohl’s Products unified schema. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_KOHLS_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Kohl’s Products unified schema on kohls.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_KROGER_COM_SEARCHCollect Kroger.com - Search. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured rank, page, sku, url data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Kroger.com - Search on kroger.com.
array
required
collect_by_url requires url; accepted optional fields: page. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_KROGER_PRODUCTSCollect Kroger.com. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured sku, variant_id, url, rootdomain data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Kroger.com on kroger.com.
array
required
collect_by_url requires url; accepted optional fields: zip_code. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LINKEDIN_COMPANIESCollect structured LinkedIn company details, including size, industry, locations, followers, specialties, and website. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LINKEDIN_JOBSCollect LinkedIn job listings or discover jobs by keyword, location, and search URL, returning role, employer, location, summary, and pay data. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword" | "discover_by_url")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_keyword requires location; accepted optional fields: company, country, experience_level, job_type, jobs_to_not_include, keyword, location_radius, remote, selective_search, time_range. discover_by_url requires url; accepted optional fields: selective_search.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LINKEDIN_PEOPLE_SEARCHSearch LinkedIn people and return matching profile URLs, names, subtitles, locations, experience, education, and avatars. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: first_name, last_name.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LINKEDIN_POSTSCollect LinkedIn posts directly or discover posts from company, profile, and article-feed URLs, returning text, media, dates, and engagement. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_company_url" | "discover_by_profile_url" | "discover_by_url")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: num_connections. discover_by_company_url requires url; accepted optional fields: end_date, start_date. discover_by_profile_url requires url; accepted optional fields: end_date, only_authored_posts, start_date. discover_by_url requires url; accepted optional fields: limit.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LINKEDIN_PROFILESCollect structured LinkedIn person profiles, including identity, location, company, follower, education, and public career data. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LL_BEAN_PRODUCTSCollect llbean.com - Products. Supports collect_by_url, discover_by_category. Returns structured identity, product_name, url, description data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_LL_BEAN_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for llbean.com - Products on global.llbean.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_LL_BEAN_PRODUCTS_UNIFIED_SCHEMACollect LLBean. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_LL_BEAN_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for LLBean on global.llbean.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_MACYS_COM_REVIEWSCollect Macys.com - Reviews. Supports collect_by_url, discover_by_sku. Returns structured url, rootdomain, sku, review_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_sku")
required
Bright Data collection method for Macys.com - Reviews on macys.com.
array
required
collect_by_url requires sku, url; accepted optional fields: none. discover_by_sku requires sku; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_MACYS_PRODUCTSCollect Macys.com. Supports collect_by_url, discover_by_category_url, discover_by_keyword. Returns structured url, star_rating_distribution, quantity_sold, is_promo data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_MACYS_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category_url" | "discover_by_keyword")
required
Bright Data collection method for Macys.com on macys.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category_url requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_MACYS_PRODUCTS_UNIFIED_SCHEMACollect Macys Products unified schema. Supports collect_by_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_MACYS_PRODUCTS action for its richer site-specific schema.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_MASSIMO_DUTTI_PRODUCTSCollect Massimo Dutti - Products . Supports collect_by_url, discover_by_category. Returns structured url, title, price, product_type data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_MASSIMO_DUTTI_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for Massimo Dutti - Products on massimodutti.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_MASSIMO_DUTTI_PRODUCTS_UNIFIED_SCHEMACollect Massimodutti. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_MASSIMO_DUTTI_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Massimodutti on massimodutti.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_META_AD_LIBRARYCollect Meta - Ad Library . Supports collect_by_url, discover_by_keyword. Returns structured url, library_id, is_active, status data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword")
required
Bright Data collection method for Meta - Ad Library on facebook.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_keyword requires ad_type, country, keyword; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_OVERSTOCK_COM_REVIEWSCollect Overstock.com - Reviews. Supports collect_by_url, discover_by_sku. Returns structured rootdomain, sku, variant_sku, review_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_sku")
required
Bright Data collection method for Overstock.com - Reviews on overstock.com.
array
required
collect_by_url requires sku, url; accepted optional fields: none. discover_by_sku requires sku; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_OVERSTOCK_PRODUCTSCollect Overstock.com. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured url, star_rating_distribution, is_promo, other_price_options data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_OVERSTOCK_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Overstock.com on overstock.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_OVERSTOCK_PRODUCTS_UNIFIED_SCHEMACollect Overstock Products unified schema. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_OVERSTOCK_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Overstock Products unified schema on overstock.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_PINTEREST_POSTSCollect Pinterest - Posts . Supports collect_by_url, discover_by_profile_url. Returns structured url, post_id, title, content data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_profile_url")
required
Bright Data collection method for Pinterest - Posts on pinterest.com.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_profile_url requires url; accepted optional fields: end_date, num_of_posts, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_PINTEREST_PROFILESCollect Pinterest - Profiles. Supports collect_by_url, discover_by_keyword. Returns structured url, profile_picture, name, nickname data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword")
required
Bright Data collection method for Pinterest - Profiles on pinterest.com.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_keyword requires keyword; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_POSHMARK_PRODUCTSCollect Poshmark.com. Supports collect_by_url, discover_by_category, discover_by_keyword. Returns structured url, is_promo, seller_id, other_price_options data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_POSHMARK_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword")
required
Bright Data collection method for Poshmark.com on poshmark.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_category requires category_url; accepted optional fields: page. discover_by_keyword requires keyword; accepted optional fields: page.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_POSHMARK_PRODUCTS_UNIFIED_SCHEMACollect Poshmark Products unified schema. Supports collect_by_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_POSHMARK_PRODUCTS action for its richer site-specific schema.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_REDDIT_COMMENTSCollect Reddit - Comments. Supports collect_by_url. Returns structured url, comment_id, user_posted, comment data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: comment_limit, days_back, load_all_replies, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_REDDIT_POSTSCollect Reddit- Posts. Supports collect_by_url, discover_by_author_url, discover_by_keyword, discover_by_subreddit_url. Returns structured post_id, url, user_posted, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_author_url" | "discover_by_keyword" | "discover_by_subreddit_url")
required
Bright Data collection method for Reddit- Posts on reddit.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_author_url requires url; accepted optional fields: keyword, num_of_posts, sort_by, sort_by_time. discover_by_keyword requires date, keyword; accepted optional fields: num_of_posts, sort_by. discover_by_subreddit_url requires url; accepted optional fields: keyword, num_of_posts, sort_by, sort_by_time, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_REDDIT_PROFILESCollect Reddit - Profiles. Supports collect_by_url. Returns structured url, profile_id, name, followers data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_SNAPCHAT_POSTSCollect Snapchat posts. Supports collect_by_url, discover_by_profile, discover_by_search_url. Returns structured url, post_id, profile_name, profile_handle data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_profile" | "discover_by_search_url")
required
Bright Data collection method for Snapchat posts on www.snapchat.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_profile requires url; accepted optional fields: tab. discover_by_search_url requires tab, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_SNAPCHAT_PROFILECollect Snapchat profile. Supports collect_by_url. Returns structured url, profile_id, profile_name, profile_username data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires collect_all_highlights, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_THREADS_POSTSCollect Threads - Posts. Supports collect_by_url, discover_by_profile. Returns structured post_id, url, post_time, profile_name data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_profile")
required
Bright Data collection method for Threads - Posts on threads.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_profile requires profile_url; accepted optional fields: end_date, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_THREADS_PROFILESCollect Threads - Profiles. Supports collect_by_url. Returns structured url, profile_name, profile_id, about_formatted data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_COMMENTSCollect TikTok comments with text, dates, likes, replies, commenter identity, and source-post details. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: collect_replies, include_comments, num_of_comments.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_POSTSCollect TikTok posts with the full post dataset. Use for post URLs, keyword discovery, profile discovery, or discovery URLs when the richer non-fast schema is needed. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword" | "discover_by_profile_url" | "discover_by_url")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: country, discovery_input. discover_by_keyword requires search_keyword; accepted optional fields: country, num_of_posts, posts_to_not_include. discover_by_profile_url requires url; accepted optional fields: country, end_date, include_pinned_post, num_of_posts, post_type, posts_to_not_include, sort_by, start_date, what_to_collect. discover_by_url requires discovery_url; accepted optional fields: country, num_of_posts.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_POSTS_FASTCollect individual TikTok post URLs with the fast dataset. Use instead of the full post dataset when lower latency matters and URL-only collection is sufficient. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: end_date, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_PROFILE_POSTS_FASTDiscover TikTok posts from profile URLs with the fast profile-post dataset. Use for profile feeds, not individual post URLs or keyword search. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: end_date, num_of_posts, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_PROFILESCollect structured TikTok - Profiles data from tiktok.com, including account_id, nickname, biography, awg_engagement_rate, comment_engagement_rate. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_search_url")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: country, discovery_input. discover_by_search_url requires country, search_url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_SEARCH_POSTS_FASTDiscover TikTok posts from search or discovery URLs with the fast search-post dataset. Use for search results, not profile feeds or individual post URLs. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: country, end_date, num_of_posts, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_SHOPCollect structured TikTok Shop data from tiktok.com, including url, title, available, description, currency. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category" | "discover_by_keyword" | "discover_by_shop")
required
Collection or discovery method to run.
array
required
collect_by_url requires url; accepted optional fields: category, category_url, country, position. discover_by_category requires category_url; accepted optional fields: none. discover_by_keyword requires keyword; accepted optional fields: domain. discover_by_shop requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TIKTOK_SHOP_CATEGORY_PRODUCTSCollect structured TikTok Shop Category Products data from tiktok.com, including url, product_id, category_url, category_name, sub_categories. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TRIP_COM_FLIGHTS_MOBILE_APPCollect Trip.com - Flights (mobile-app). Supports collect_by_url. Returns structured url, origin_code, destination_code, departure_date data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires adults, cabin, children, currency, departure_date, destination_code, infants, origin_code, url; accepted optional fields: country, language.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TRIP_COM_HOTEL_LISTINGSCollect Trip Hotel Listings. Supports collect_by_url, discover_by_location. Returns structured url, hotel_id, title, location data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_location")
required
Bright Data collection method for Trip Hotel Listings on trip.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_location requires adults, check_in, check_out, location, rooms; accepted optional fields: children, children_age, country, currency.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TRIP_COM_HOTELS_MOBILE_APPCollect Trip.com - Hotels (mobile-app). Supports collect_by_url, discover_by_location. Returns structured url, check_in, check_out, adults data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_location")
required
Bright Data collection method for Trip.com - Hotels (mobile-app) on trip.com.
array
required
collect_by_url requires adults, check_in, check_out, rooms, url; accepted optional fields: child_ages, children, country, currency, hotel_id, language. discover_by_location requires adults, check_in, check_out, destination, destination_match, rooms; accepted optional fields: child_ages, children, country, currency, language.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_TRIP_COM_LISTINGS_SEARCHCollect Trip Listings Search. Supports collect_by_url. Returns structured url, location, check_in, check_out data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires adults, check_in, check_out, location, rooms, url; accepted optional fields: children, children_age, country, currency.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_WALMART_PRODUCTSCollect Walmart - products . Supports collect_by_url, discover_by_category_url, discover_by_keyword, discover_by_sku. Returns structured url, final_price, sku, currency data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category_url" | "discover_by_keyword" | "discover_by_sku")
required
Bright Data collection method for Walmart - products on walmart.com.
array
required
collect_by_url requires url; accepted optional fields: all_variations, store_id, zipcode. discover_by_category_url requires category_url; accepted optional fields: all_variations. discover_by_keyword requires domain, keyword; accepted optional fields: all_variations. discover_by_sku requires none; accepted optional fields: all_variations, sku.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_WALMART_PRODUCTS_SEARCHCollect Walmart products search. Supports collect_by_url. Returns structured id, url, typename, buy_box_suppression data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_WALMART_PRODUCTS_ZIPCODESCollect Walmart product URLs with zipcode-specific availability and pricing. Use when location-specific product data is required. Supports collect_by_url, discover_by_category_url, discover_by_keyword. Returns structured url, final_price, sku, currency data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_category_url" | "discover_by_keyword")
required
Bright Data collection method for Walmart - products zipcodes on walmart.com.
array
required
collect_by_url requires url, zip_code; accepted optional fields: store_id. discover_by_category_url requires url, zip_code; accepted optional fields: all_variations, begin_page, limitations, max_product, shipping_type, store_id. discover_by_keyword requires keyword, zip_code; accepted optional fields: store_id.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_WALMART_REVIEWSCollect Walmart Reviews. Supports collect_by_url. Returns structured url, product_name, product_id, rating data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: days_back, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_WALMART_SELLERS_INFOCollect Walmart sellers info. Supports collect_by_url. Returns structured seller_id, url, catalog_seller_id, seller_name data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_X_POSTSCollect X (formerly Twitter) - Posts. Supports collect_by_url, discover_by_profile_url. Returns structured id, user_posted, name, description data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_profile_url")
required
Bright Data collection method for X (formerly Twitter) - Posts on x.com.
array
required
collect_by_url requires url; accepted optional fields: country. discover_by_profile_url requires url; accepted optional fields: end_date, include_reposts, num_of_posts, posts_to_not_include, start_date.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_X_PROFILESCollect X (formerly Twitter) - Profiles. Supports collect_by_url, discover_by_user_name. Returns structured x_id, url, id, profile_name data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_user_name")
required
Bright Data collection method for X (formerly Twitter) - Profiles on x.com.
array
required
collect_by_url requires url; accepted optional fields: max_number_of_posts. discover_by_user_name requires user_name; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_YELP_BUSINESSES_OVERVIEWCollect Yelp businesses overview. Supports collect_by_url, discover_by_bounding_box, discover_by_search_filters, discover_by_url. Returns structured business_id, yelp_biz_id, name, updates_from_business data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_bounding_box" | "discover_by_search_filters" | "discover_by_url")
required
Bright Data collection method for Yelp businesses overview on yelp.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_bounding_box requires category, location; accepted optional fields: none. discover_by_search_filters requires category, location; accepted optional fields: country. discover_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_YELP_BUSINESSES_REVIEWSCollect Yelp businesses reviews. Supports collect_by_url, discover_by_search_filters. Returns structured business_id, Review_auther, Rating, Date data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_search_filters")
required
Bright Data collection method for Yelp businesses reviews on yelp.com.
array
required
collect_by_url requires url; accepted optional fields: end_date, sort_by, start_date, unrecommended_reviews. discover_by_search_filters requires category, location; accepted optional fields: country.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_YOUTUBE_CHANNELSCollect YouTube - Channels. Supports collect_by_url, discover_by_keyword. Returns structured url, handle, handle_md5, banner_img data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_keyword")
required
Bright Data collection method for YouTube - Channels on youtube.com.
array
required
collect_by_url requires url; accepted optional fields: discovery_input. discover_by_keyword requires keyword; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_YOUTUBE_COMMENTSCollect Youtube - Comments. Supports collect_by_url. Returns structured comment_id, comment_text, likes, replies data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: include_comments, load_replies, num_of_comments, sort_by.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_YOUTUBE_VIDEOSCollect Youtube - Videos posts. Supports collect_by_url, discover_by_explore, discover_by_hashtag, discover_by_keyword, discover_by_podcast_url, discover_by_search_filters, discover_by_url. Returns structured url, title, youtuber, youtuber_md5 data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_explore" | "discover_by_hashtag" | "discover_by_keyword" | "discover_by_podcast_url" | "discover_by_search_filters" | "discover_by_url")
required
Bright Data collection method for Youtube - Videos posts on youtube.com.
array
required
collect_by_url requires url; accepted optional fields: country, discovery_input, subscribers, transcription_language. discover_by_explore requires url; accepted optional fields: all_tabs, country. discover_by_hashtag requires hashtag; accepted optional fields: country, end_date, num_of_posts, posts_to_not_include, start_date. discover_by_keyword requires keyword; accepted optional fields: country, end_date, include_shorts, num_of_posts, start_date. discover_by_podcast_url requires url; accepted optional fields: none. discover_by_search_filters requires keyword_search; accepted optional fields: country, duration, features, sort_by, type, upload_date. discover_by_url requires url; accepted optional fields: country, end_date, num_of_posts, order_by, start_date, time_period, transcription_language.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZARA_HOME_PRODUCTSCollect Zara Home Products. Supports collect_by_url. Returns structured category_id, category_key, category_name, product_id data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_ZARA_HOME_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZARA_HOME_PRODUCTS_UNIFIED_SCHEMACollect Zara Home products. Supports collect_by_url, discover_by_category_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_ZARA_HOME_PRODUCTS action for its richer site-specific schema.

Input Parameters

string ("collect_by_url" | "discover_by_category_url")
required
Bright Data collection method for Zara Home products on zarahome.com.
array
required
collect_by_url requires all_variations, url; accepted optional fields: none. discover_by_category_url requires all_variations, url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZARA_PRODUCTSCollect Zara - Products . Supports collect_by_url, discover_by_category. Returns structured category_id, product_id, product_name, price data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This is the provider-native schema; use BRIGHTDATA_SCRAPE_ZARA_PRODUCTS_UNIFIED_SCHEMA for standardized commerce fields.

Input Parameters

string ("collect_by_url" | "discover_by_category")
required
Bright Data collection method for Zara - Products on zara.com.
array
required
collect_by_url requires url; accepted optional fields: seo_category_id. discover_by_category requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZARA_PRODUCTS_UNIFIED_SCHEMACollect Zara.com products. Supports collect_by_url. Returns structured url, item_id, variant_id, title data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID. This returns standardized commerce fields; use the provider-native BRIGHTDATA_SCRAPE_ZARA_PRODUCTS action for its richer site-specific schema.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: all_variations.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZILLOW_PROPERTIESCollect full property details for Zillow property URLs. Use for property-level facts rather than search listings or price-history-only records. Supports collect_by_url, discover_by_search_url. Returns structured url, photos, responsive_photos, has_vr_model data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_search_url")
required
Bright Data collection method for Zillow Full Properties Information on zillow.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_search_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZILLOW_PROPERTY_LISTINGSCollect Zillow listing URLs or discover property listings from filters or search URLs. Returns listing-level records for search and listing workflows. Supports collect_by_url, discover_by_input_filters, discover_by_url. Returns structured zpid, city, state, homeStatus data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string ("collect_by_url" | "discover_by_input_filters" | "discover_by_url")
required
Bright Data collection method for Zillow properties listing information on zillow.com.
array
required
collect_by_url requires url; accepted optional fields: none. discover_by_input_filters requires location; accepted optional fields: HomeType, days_on_zillow, exact_address, listingCategory. discover_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZILLOW_PROPERTY_PRICE_HISTORYCollect the price-history timeline for Zillow property URLs. Use when historical price events are needed rather than full property details or search listings. Supports collect_by_url. Returns structured url, zpid, date, event data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: none.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SCRAPE_ZILLOW_PROPERTY_SEARCH_RESULTSCollect Zillow search-page URLs into search-result property records. Use for an existing results page rather than filter-based listing discovery. Supports collect_by_url. Returns structured url, zpid, zipcode, description data and preserves additional provider fields. This action uses a fixed dataset; use BRIGHTDATA_SCRAPE_DATA_SYNC only when supplying a different dataset ID.

Input Parameters

string
Fixed to collect_by_url for this dataset; callers can omit this field.
array
required
collect_by_url requires url; accepted optional fields: include_offmarket.
string ("json" | "csv" | "ndjson" | "jsonl")
Result format. Synchronous requests support json, csv, and ndjson; asynchronous requests also support jsonl.
string ("synchronous" | "asynchronous")
Run synchronously for a direct response, or asynchronously to return a snapshot ID for later polling and download.
boolean
Whether Bright Data should include record-level errors.
integer
Maximum records returned for each discovery input.
string
Pipe-separated output fields to retain in each result record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SEARCH_BUSINESS_RECORDSSearch public company or professional-profile records synchronously using structured queries in Ludicrous mode or natural language in Instant/Smart mode. Results default to identifiers only; select a view or fields for additional data.Instant: Supported on the latest version.Instant pricing: $0.002 per Ludicrous or Instant page, $0.003 per Smart page; empty pages billed.

Input Parameters

string ("ludicrous" | "instant" | "smart")
required
Ludicrous takes a structured filter. Instant and Smart take natural-language queries. Smart costs more and permits up to 10 results.
string ("id_only" | "summary" | "full")
Predefined fields returned per document. Use fields instead for a custom field selection.
integer
Maximum records in this page. Up to 100 for Ludicrous/Instant and 10 for Smart.
object
required
Required query payload. Set structured_filter for Ludicrous mode or natural_language for Instant/Smart mode.
array
Custom released field names to return. Cannot be combined with summary or full view.
integer
Results to skip. Ludicrous allows offsets up to 1000; Instant/Smart offset plus limit must not exceed 100.
string
Optional source. The provider defaults to linkedin_company for company searches and linkedin_people for people searches.
string ("company" | "people")
required
Business record type to search: companies or professional profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SEARCH_DATASETSearch a supported LinkedIn profiles, contact-enriched profiles, or companies Marketplace dataset and return matching records synchronously. Managed connections restrict searches to the public profiles and companies datasets.Instant: Supported on the latest version.Instant pricing: $2.500 per 1,000 returned records. No charge for zero returned records.

Input Parameters

integer
Requested maximum records in this synchronous call. The price scales with records returned. Some connections allow 1–100 records (at most $0.25 per call); others allow 1–1000. Actual account limits may be lower.
string ("default" | "random")
Optional provider sort mode: default or random.
string
required
Field comparison, null check, or and/or group. Groups support at most three levels of nesting.
string ("gd_l1viktl72bvl7bjuj0" | "gd_me5ppxjr2ge6icjuh0" | "gd_l1vikfnt1wgvvqz95w")
required
Search-enabled dataset ID: gd_l1viktl72bvl7bjuj0 (LinkedIn profiles), gd_me5ppxjr2ge6icjuh0 (contact-enriched profiles), or gd_l1vikfnt1wgvvqz95w (companies).
array
Custom field-sort clauses. Cannot be combined with sort.
array
Pagination cursor returned with a sorted previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SEARCH_SERP_SYNCSearch Google, Bing, DuckDuckGo or Yandex synchronously for standard text results. JSON results preserve engine-specific fields and metadata; enabling markdown conversion returns text instead, even when JSON is selected.

Input Parameters

string
required
SERP API zone from your Bright Data account.
string
required
Text search query. This action returns results in the same request without creating an async response ID.
string ("json" | "raw")
JSON returns the complete provider results object; raw returns text/HTML content.
string
Optional two-letter country code for localized results. When omitted, the SERP zone configuration selects the location.
string ("google" | "bing" | "duckduckgo" | "yandex")
Search engine for a standard text query.
boolean
Convert text output to markdown. Screenshots and advanced SERP products are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SEARCH_WEB_ARCHIVESearch Bright Data’s Web Archive and estimate matching files, dump size in bytes, and dump cost in USD. A search that exceeds 30 seconds returns only a search_id; pass it to BRIGHTDATA_GET_WEB_ARCHIVE_SEARCH until complete. The search itself estimates a dump and does not create a billable dump. Up to 100 searches that have not had a dump triggered are allowed per day.

Input Parameters

object
required
Required archive filters. A search needs exactly one time-range form. Up to 100 searches that have not had a dump triggered are allowed per day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_SERP_SEARCHSubmit an asynchronous SERP search and return its response_id. Retrieve it with BRIGHTDATA_GET_SERP_RESULTS, selecting the same JSON or raw result format used here.

Input Parameters

string
required
SERP API zone name. Use BRIGHTDATA_LIST_UNLOCKER_ZONES to discover configured zones.
string
required
Search query to execute.
string ("json" | "raw")
Provider response format requested for the async job.
string
Two-letter ISO country code for localized results.
string ("markdown" | "screenshot")
Optional transformation: markdown text or a screenshot.
string ("google" | "bing" | "yahoo" | "duckduckgo" | "yandex")
Search engine to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_START_DEEP_LOOKUPStart an asynchronous Deep Lookup research request and return its request_id. Billing is $1 per matched record; the first 10 enrichment columns are included, each additional enrichment column costs $0.05, and skipped or unmatched records are free. The API may return HTTP 429; retry according to Retry-After when present rather than using a fixed request rate.

Input Parameters

string
Machine-readable name for the requested entity collection.
string
required
Research query. Bright Data requires it to begin with ‘Find all’.
string
Optional human-readable title for the lookup.
array
required
Columns to enrich or use as constraints for every matched record.
integer
required
Maximum number of matched, billable records to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRIGHTDATA_WEB_UNLOCKERScrape a public URL through Web Unlocker when ordinary requests are blocked or require JavaScript rendering. Inspect returned content before retrying CAPTCHA pages.

Input Parameters

string
required
The URL of the website to unlock and scrape.
string
required
Web Unlocker zone name (required, non-empty). Call BRIGHTDATA_LIST_WEB_UNLOCKER_ZONES first to get available zones.
string ("raw" | "json")
Response format - ‘raw’ returns HTML content as string, ‘json’ returns structured data.
string
ISO 3166-1 alpha-2 country code for the proxy location (e.g., ‘us’, ‘gb’, ‘de’).
string
Set to ‘markdown’ to convert page content to markdown format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not