Chrome DevTools Protocol API Reference
All the frameworks that use the Chrome DevTools Protocol (CDP) can be configured with the following properties. You have to configure the properties in the websocket URL used to connect to our browsers.
Properties
accessKey=${ACCESS_KEY} Required The access key is required connect to our managed pool of browsers. It's important to keep your access keys private to prevent unauthorized access. You can create your access key from the access keys dashboard.
timezone=${TIMEZONE} OptionalBy default the browser will use the timezone related to hosted location. If you use our residential proxies, the timezone will be set to the proxy location. If you need to override the timezone, which is not recommended unless you provide your own proxy, you can by using one of the following timezones.
proxyUrl=${HTTP_PROXY_URL} OptionalTo use your own proxy, you have to pass your proxy URL to the browser. The HTTP proxy URL has to
match the following pattern http://${USERNAME}:${PASSWORD}@${HOSTNAME}:${PORT}. The proxy URL has priority over the other proxy parameters.
userDataId=${USER_DATA_ID} OptionalIf you want to persist and reuse the user data related to your browser session. You have to set
the a unique ID to the user data. The ID has to match /^[a-zA-Z0-9-_]{1,64}$/.
The user data will be downloaded before starting the browser and will be saved at the end of the browser session. The user data saved will override the previous version of the user data. If the user data doesn't exist, it will be created from the user data of the browser session.
userDataReadOnly=${true|false} OptionalIf you want to use the user data without updating it at the end of the browser session. You have
to set the read only property to true. It will download the user data and start the
browser with it, but won't saved its new state at the end of the browser session.
Examples
wss://cdp.blitzbrowser.com?accessKey=${ACCESS_KEY} It will connect your CDP framework to one of our browsers. No proxy will be used and you will connect to the internet from our datacenter IPs.
