POST
/
datasets
/
v3
/
scrape
Scrape data and return it directly in the response.
curl --request POST \
  --url https://api.brightdata.com/datasets/v3/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "input": [
    {
      "url": "www.linkedin.com/in/bulentakar"
    }
  ],
  "custom_output_fields": "url|about.updated_on"
}'
"OK"

​
How It Works

This synchronous API endpoint allows users to send a scraping request and receive the results directly in the response, at the point of request—such as a terminal or application—without the need for external storage or manual downloads. This approach streamlines the data collection process by eliminating additional steps for retrieving results. You can specify the desired output format using the format parameter. If no format is provided, the response will default to JSON.

​
Timeout Limit

Please note that this synchronous request is subject to a timeout limit. If the data retrieval process exceeds this limit, the API will return an HTTP 202 response, indicating that the request is still being processed. In such cases, you will receive a snapshot ID to monitor and retrieve the results asynchronously via the Monitor Snapshot and Download Snapshot endpoints. Example response on timeout:
202
{
  "snapshot_id": "s_xxx",
  "message": "Your request is still in progress and cannot be retrieved in this call. Use the provided Snapshot ID to track progress via the Monitor Snapshot endpoint and download it once ready via the Download Snapshot endpoint."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
dataset_id
string
required

Dataset ID for which data collection is triggered.

​
custom_output_fields
string

List of output columns, separated by | (e.g., url|about.updated_on). Filters the response to include only the specified fields.

Example:

"url|about.updated_on"

​
include_errors
boolean

Include errors report with the results.

​
format
enum<string>
default:json

Specifies the format of the response (default: JSON).

Available options:
json,
csv

Body

application/json

Response

200
text/plain

OK

The response is of type string.

Example:

"OK"