/chrome/unblock
POST/chrome/unblock
Unblocks the provided URL from being blocked due to bot detection. Returns a payload of Cookies, HTML, a base64 encoded screenshot, and a "browserWSEndpoint" to allow connecting to the browser when specified in the JSON Payload. Only supports CDP or Puppeteer like libraries when connecting to the "browserWSEndpoint".
Request
Query Parameters
Possible values: [phone, tablet]
Possible values: [android, ios, linux, macos, windows]
Possible values: [datacenter, residential]
Possible values: [0, 1, false, true]
Possible values: [0, 1, false, true]
Body
- Schema
- JSON
- PuppeteerLifeCycleEvent[]
- string
- Array [
- ]
- object
- null
When true, browserless proceeds when "awaited" events fail or timeout (goto, waitForSelector, and more).
The URL of the site you want to unblock.
Whether or not to keep the underlying browser alive and around for future reconnects. Defaults to false.
Whether or not to to return cookies for the site, defaults to true.
Whether or not to to return content for the site, defaults to true.
Whether or not to to return a full-page screenshot for the site, defaults to true.
How long to keep the browser alive for re-connection when browserWSEndpoint is requested. Maximum of 30000 (30 seconds).
gotoOptions object
An optional goto parameter object for considering when the page is done loading.
If provided, it will take preference over the referer header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.
If provided, it will take preference over the referer-policy header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.
Maximum wait time in milliseconds. Pass 0 to disable the timeout.
The default value can be changed by using the {@link Page.setDefaultTimeout} or {@link Page.setDefaultNavigationTimeout} methods.
waitUntil object
When to consider waiting succeeds. Given an array of event strings, waiting is considered to be successful after all events have been fired.
Possible values: [domcontentloaded, load, networkidle0, networkidle2]
signal object
A signal object that allows you to cancel the call.
onabort objectrequired
waitForEvent object
Options for waiting for a specific event to be fired on the page.
waitForFunction object
Options for waiting for a JavaScript function to execute.
The function, or statement, to be evaluated in browser context
An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: "raf" or "mutation"
Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
waitForSelector object
Options for waiting for a specific CSS selector to appear on the page.
The amount of time in milliseconds to wait before proceeding.
{
"bestAttempt": true,
"url": "string",
"browserWSEndpoint": true,
"cookies": true,
"content": true,
"screenshot": true,
"ttl": 0,
"gotoOptions": {
"referer": "string",
"referrerPolicy": "string",
"timeout": 0,
"waitUntil": [
"domcontentloaded"
],
"signal": {
"aborted": true,
"onabort": {},
"reason": {}
}
},
"waitForEvent": {
"event": "string",
"timeout": 0
},
"waitForFunction": {
"fn": "string",
"polling": "string",
"timeout": 0
},
"waitForSelector": {
"hidden": true,
"selector": "string",
"timeout": 0,
"visible": true
},
"waitForTimeout": 0
}
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 429
- 500
- 503
Schema
- Fields
- Example (auto)
- Array [
- ]
cookies object[]required
A list of cookies which can be used for new connections or for usage elsewhere. Value is "null" when the request body specifies cookies: false.
The HTML content of the page once it is passed bot detection. Value is "null" when the request body specifies content: false.
The browserWSEndpoint of the response when the POST body contains a browserWSEndpoint: true property
Time the browser stays alive until shutdown; zero when browserWSEndpoint: false. Limit is 60000 (60 seconds).
A base64 encoded JPEG of the of the final site page.
Whether a detected anti-bot challenge was successfully solved during the unblock. False when none was present or a present one could not be solved.
{
"cookies": [
{
"name": "string",
"value": "string",
"domain": "string",
"path": "string",
"expires": 0,
"httpOnly": true,
"secure": true,
"sameSite": "string",
"url": "string"
}
],
"content": "string",
"browserWSEndpoint": "string",
"ttl": 0,
"screenshot": "string",
"solved": true
}
The request contains errors or didn't properly encode content.
The request is missing, or contains bad, authorization credentials.
The request targets a destination that is not allowed.
Resource couldn't be found.
The request took has taken too long to process.
Too many requests are currently being processed.
An internal error occurred when handling the request.
Service is unavailable.