View as Markdown
Bright Data icon

Bright Data ACTION

Unlock Website

Send an API call to a URL and get the HTML back. Enables you to bypass anti-bot measures, manages proxies, and solves CAPTCHAs automatically for easier web data collection. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Bright Data account once, then configure and run Unlock Website from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "bright_data-unlock-website",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bright_data: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    zone: "Zone",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Unlock Website inputs
Property Type Description
url URL string
Complete target URL to scrape. Must include protocol (http/https), be publicly accessible.
Required
zone Zone string
Zone identifier that defines your Bright Data product configuration. Each zone contains targeting rules, output preferences, and access permissions. Manage zones at: https://brightdata.com/cp/zones
Required Dynamic
format Format string
Output format of the response
Required
method Method string
HTTP method to use for the request
Optional
country Country string
Two-letter ISO 3166-1 country code for proxy location
Optional
dataFormat Data Format string
Additional response format transformation: markdown converts HTML content to clean markdown format, screenshot captures a PNG image of the rendered page.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
bright_data-unlock-website
Version
0.0.2
App
Bright Data
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes