API

Every brightdata.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Crawl Api

crawlApi

crawlApi Tool to trigger an asynchronous site crawl for a dataset and list of URLs. Returns snapshot_id required by getSnapshotStatus and getSnapshotResults. Risk: write

await corsair.brightdata.api.crawlApi({});

Input

Name	Type	Required	Description
`dataset_id`	`string`	Yes	Official query: ?dataset_id=
`items`	`object[]`	Yes	—
`include_errors`	`boolean`	No	—
`custom_output_fields`	`string`	No	—

items full type

{
}[]

Output

Name	Type	Required	Description
`snapshot_id`	`string`	Yes	—

Filter Dataset

filterDataset

filterDataset Tool to apply custom filter criteria to a marketplace dataset (BETA). Use after selecting a dataset to generate a filtered snapshot. Risk: write

await corsair.brightdata.api.filterDataset({});

Input

Name	Type	Required	Description
`dataset_id`	`string`	Yes	—
`filter`	`object`	Yes	—
`records_limit`	`number`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`snapshot_id`	`string`	Yes	—

Get Available Cities

getAvailableCities

getAvailableCities Tool to get available static network cities for a given country. Use when you need to configure static proxy endpoints after selecting a country. Risk: read

await corsair.brightdata.api.getAvailableCities({});

Input

Name	Type	Required	Description
`country`	`string`	Yes	Official query: ?country=
`pool_ip_type`	`dc \| static_res`	No	—

Output: string[]

Get Available Countries

getAvailableCountries

getAvailableCountries Tool to list available countries and their ISO 3166-1 alpha-2 codes. Use when you need to configure zones with valid country codes before provisioning proxies. Risk: read

await corsair.brightdata.api.getAvailableCountries({});

Input: empty object Output

Name	Type	Required	Description
`zone_types`	`object`	No	—

zone_types full type

{
}

Get Snapshot Results

getSnapshotResults

getSnapshotResults Tool to retrieve the scraped data from a completed crawl job by snapshot ID. Only call after confirming the job is complete via getSnapshotStatus. Risk: read

await corsair.brightdata.api.getSnapshotResults({});

Input

Name	Type	Required	Description
`snapshot_id`	`string`	Yes	Official path on GET /datasets/v3/snapshot/
`format`	`json \| ndjson \| jsonl \| csv`	No	—
`compress`	`boolean`	No	—
`batch_size`	`number`	No	—
`part`	`number`	No	—

Output: object

Output full type

{
}[] | string

Get Snapshot Status

getSnapshotStatus

getSnapshotStatus Tool to check the processing status of a crawl job using snapshot ID. Call before attempting to download results to ensure data collection is complete. Risk: read

await corsair.brightdata.api.getSnapshotStatus({});

Input

Name	Type	Required	Description
`snapshot_id`	`string`	Yes	Official path on GET /datasets/v3/progress/

Output

Name	Type	Required	Description
`snapshot_id`	`string`	No	—
`dataset_id`	`string`	No	—
`status`	`starting \| running \| ready \| failed \| canceled`	Yes	—

List Datasets

listDatasets

listDatasets Tool to list all available pre-made scrapers (datasets) from Bright Data marketplace. Use when you need to browse available data sources for structured scraping. Risk: read

await corsair.brightdata.api.listDatasets({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  name: string,
  size?: number
}[]

List Web Unlocker Zones

listWebUnlockerZones

listWebUnlockerZones Tool to list your configured Web Unlocker zones and proxy endpoints. Use to view available zones for web scraping and bot protection bypass. Risk: read

await corsair.brightdata.api.listWebUnlockerZones({});

Input: empty object Output: object[]

Output full type

{
  name: string,
  type?: string
}[]

Serp Search

serpSearch

serpSearch Tool to perform SERP searches across search engines using Bright Data SERP API. Use when you need search results, trending topics, or competitive analysis data. Risk: read

await corsair.brightdata.api.serpSearch({});

Input

Name	Type	Required	Description
`zone`	`string`	Yes	—
`q_keywords`	`string`	Yes	—
`search_engine`	`google \| bing \| yahoo \| yandex \| duckduckgo`	No	—
`format`	`json \| raw`	No	—
`method`	`string`	No	—
`country`	`string`	No	—
`data_format`	`markdown \| screenshot`	No	—

Output: object

Output full type

string | {
  general?: {
  },
  input?: {
  },
  organic?: {
  }[]
}

Web Unlocker

webUnlocker

webUnlocker Tool to bypass bot detection, captcha, and other anti-scraping measures to extract content from websites. Use when sites block automated access or require JavaScript rendering. Risk: read

await corsair.brightdata.api.webUnlocker({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`zone`	`string`	Yes	—
`format`	`json \| raw`	No	—
`country`	`string`	No	—
`data_format`	`markdown \| screenshot`	No	—

Output: object

Output full type

string | {
  status_code?: number,
  headers?: {
  },
  body?: any
}

Overview

Plugins

Crawl Api

crawlApi

Filter Dataset

filterDataset

Get Available Cities

getAvailableCities

Get Available Countries

getAvailableCountries

Get Snapshot Results

getSnapshotResults

Get Snapshot Status

getSnapshotStatus

List Datasets

listDatasets

List Web Unlocker Zones

listWebUnlockerZones

Serp Search

serpSearch

Web Unlocker

webUnlocker

​Crawl Api

​crawlApi

​Filter Dataset

​filterDataset

​Get Available Cities

​getAvailableCities

​Get Available Countries

​getAvailableCountries

​Get Snapshot Results

​getSnapshotResults

​Get Snapshot Status

​getSnapshotStatus

​List Datasets

​listDatasets

​List Web Unlocker Zones

​listWebUnlockerZones

​Serp Search

​serpSearch

​Web Unlocker

​webUnlocker

Crawl Api

crawlApi

Filter Dataset

filterDataset

Get Available Cities

getAvailableCities

Get Available Countries

getAvailableCountries

Get Snapshot Results

getSnapshotResults

Get Snapshot Status

getSnapshotStatus

List Datasets

listDatasets

List Web Unlocker Zones

listWebUnlockerZones

Serp Search

serpSearch

Web Unlocker

webUnlocker