Skip to main content
POST
The synchronous real-time endpoint keeps the HTTP request open until the scraper finishes or the timeout is reached, then returns the collected data directly as JSON. This is the difference from the async real-time endpoint, which returns a response_id immediately.
You can trigger only single-input APIs. Make sure the payload is an object, not an array of objects.

Timeout behavior

The timeout query parameter must be between 25s and 50s.
  • If the scraper finishes within the timeout, the response returns 200 OK with the collected data.
  • If the scraper is still running when the timeout is reached, the response returns 202 Accepted with a response_id. Use that response_id with the Realtime Data endpoint to retrieve the result asynchronously.

When to use synchronous real-time

Use synchronous real-time (POST /dca/crawl) when:
  • You need the result in the same HTTP request.
  • You are sending a single input.
  • Your client can keep the request open until the scrape finishes.
  • The scrape normally completes within the configured timeout.
Use async real-time (POST /dca/trigger_immediate) when:
  • You want to trigger the scrape and retrieve the result later.
  • You do not want to keep the HTTP request open.
Use batch collection when:
  • You need to process multiple inputs in one run.

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Query Parameters

collector
string
required

A unique identification of the collector to run

Example:

"c_abc123"

timeout
string
required

How long the request stays open while waiting for the result. Must be between 25s and 50s. If the scraper finishes within the timeout, the response returns 200 OK with the collected data. If the scraper is still running when the timeout is reached, the response returns 202 Accepted with a response_id.

Example:

"50s"

version
string

Set to dev to trigger the development version of the scraper

Body

application/json

A single input object. The fields must match the input schema defined for the collector. A URL-based scraper may require url, while a search scraper may require fields such as keyword and location.

Single input object whose fields match the collector input schema.

url
string<uri>

Example field for collectors that take a target URL. Replace with the fields your collector expects.

Response

OK