For AI agents: a documentation index is available at /llms.txt
Skip to main content

/unblock

POST 

/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".

Note: Also available at /chromium/unblock as a convenience alias.

Request​

Query Parameters

    allowedDomains string[]
    blockAds boolean
    blockAdsInclude string
    credentials object
    deviceType string

    Possible values: [phone, tablet]

    emulatedDevice string
    emulationOs Platform

    Possible values: [android, ios, linux, macos, windows]

    externalProxyServer string
    integrationId string
    launch object
    profile string
    proxy ProxyType

    Possible values: [datacenter, residential]

    proxyCity string
    proxyCountry string
    proxyLocaleMatch string

    Possible values: [0, 1, false, true]

    proxyPreset string
    proxyState string
    proxySticky string

    Possible values: [0, 1, false, true]

    replay boolean
    solveCaptchas boolean
    timeout number
    token string
    trackingId string

Body

    bestAttemptboolean

    When true, browserless proceeds when "awaited" events fail or timeout (goto, waitForSelector, and more).

    urlstringrequired

    The URL of the site you want to unblock.

    browserWSEndpointboolean

    Whether or not to keep the underlying browser alive and around for future reconnects. Defaults to false.

    cookiesboolean

    Whether or not to to return cookies for the site, defaults to true.

    contentboolean

    Whether or not to to return content for the site, defaults to true.

    screenshotboolean

    Whether or not to to return a full-page screenshot for the site, defaults to true.

    ttlnumber

    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.

    refererstring

    If provided, it will take preference over the referer header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.

    referrerPolicystring

    If provided, it will take preference over the referer-policy header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.

    timeoutnumber

    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.

    anyOf
  • Array [
  • PuppeteerLifeCycleEvent

    Possible values: [domcontentloaded, load, networkidle0, networkidle2]

  • ]
  • signal object

    A signal object that allows you to cancel the call.

    abortedbooleanrequired
    onabort objectrequired
    anyOf
    object
    reasonrequired
    waitForEvent object

    Options for waiting for a specific event to be fired on the page.

    eventstringrequired
    timeoutnumber
    waitForFunction object

    Options for waiting for a JavaScript function to execute.

    fnstringrequired

    The function, or statement, to be evaluated in browser context

    pollingstring | number

    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"

    timeoutnumber

    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.

    hiddenboolean
    selectorstringrequired
    timeoutnumber
    visibleboolean
    waitForTimeoutnumber

    The amount of time in milliseconds to wait before proceeding.

Responses​

Schema
    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.

  • Array [
  • namestringrequired
    valuestringrequired
    domainstringrequired
    pathstringrequired
    expiresnumberrequired
    httpOnlybooleanrequired
    securebooleanrequired
    sameSitestringrequired
    urlstringrequired
  • ]
  • contentstringrequired

    The HTML content of the page once it is passed bot detection. Value is "null" when the request body specifies content: false.

    browserWSEndpointstringrequired

    The browserWSEndpoint of the response when the POST body contains a browserWSEndpoint: true property

    ttlnumberrequired

    Time the browser stays alive until shutdown; zero when browserWSEndpoint: false. Limit is 60000 (60 seconds).

    screenshotstringrequired

    A base64 encoded JPEG of the of the final site page.

    solvedbooleanrequired

    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.

Was this page helpful?