Zyte SmartProxy Plugin

A plugin for playwright-extra and puppeteer-extra to provide Smart Proxy Manager specific functionalities.

QuickStart for playwright-extra

1. Install Zyte SmartProxy Plugin

npm install playwright playwright-extra zyte-smartproxy-plugin puppeteer-extra-plugin-stealth @cliqz/adblocker-playwright

2. Create a file sample.js with following content and replace <SPM_APIKEY> with your SPM Apikey

1// playwright-extra is a drop-in replacement for playwright,
2// it augments the installed playwright with plugin functionality
3const { chromium } = require('playwright-extra')
4
5// add zyte-smartproxy-plugin
6const SmartProxyPlugin = require('zyte-smartproxy-plugin');
7chromium.use(SmartProxyPlugin({
8  spm_apikey: '<SPM_APIKEY>',
9  static_bypass: false, //  enable to save bandwidth (but may break some websites)
10}));
11
12// add stealth plugin and use defaults (all evasion techniques)
13const StealthPlugin = require('puppeteer-extra-plugin-stealth');
14chromium.use(StealthPlugin());
15
16// create adblocker to block all ads (saves bandwidth)
17const { PlaywrightBlocker } = require('@cliqz/adblocker-playwright');
18const fetch = require('cross-fetch');
19
20// playwright usage as normal
21(async () => {
22  const adBlocker = await PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch);
23
24  const browser = await chromium.launch({ headless: false });
25  const page = await browser.newPage({ignoreHTTPSErrors: true});
26
27  // uncomment to enable adBlocker (saves bandwidth but may break some websites)
28  // adBlocker.enableBlockingInPage(page);
29
30  await page.goto('https://toscrape.com', {timeout: 180000});
31
32  await page.screenshot({path: 'screenshot.png'})
33  await browser.close();
34})();

Make sure that you're able to make https requests using Smart Proxy Manager by following this guide Fetching HTTPS pages with Zyte Smart Proxy Manager

3. Run sample.js using Node

1node sample.js

QuickStart for puppeteer-extra

1. Install Zyte SmartProxy Plugin

npm install puppeteer puppeteer-extra zyte-smartproxy-plugin puppeteer-extra-plugin-stealth puppeteer-extra-plugin-adblocker

2. Create a file sample.js with following content and replace <SPM_APIKEY> with your SPM Apikey

1// puppeteer-extra is a drop-in replacement for puppeteer,
2// it augments the installed puppeteer with plugin functionality
3const puppeteer = require('puppeteer-extra')
4
5// add zyte-smartproxy-plugin
6const SmartProxyPlugin = require('zyte-smartproxy-plugin');
7puppeteer.use(SmartProxyPlugin({
8  spm_apikey: '<SPM_APIKEY>',
9  static_bypass: false, //  enable to save bandwidth (but may break some websites)
10}));
11
12// add stealth plugin and use defaults (all evasion techniques)
13const StealthPlugin = require('puppeteer-extra-plugin-stealth');
14puppeteer.use(StealthPlugin());
15
16// uncomment to enable adblocker plugin (saves bandwidth but may break some websites)
17// const AdBlockerPlugin = require('puppeteer-extra-plugin-adblocker');
18// puppeteer.use(AdBlockerPlugin({blockTrackers: true}));
19
20// puppeteer usage as normal
21(async () => {
22  const browser = await puppeteer.launch({ headless: false });
23  const page = await browser.newPage({ignoreHTTPSErrors: true});
24
25  await page.goto('https://toscrape.com', {timeout: 180000});
26
27  await page.screenshot({path: 'screenshot.png'})
28  await browser.close();
29})();

Make sure that you're able to make https requests using Smart Proxy Manager by following this guide Fetching HTTPS pages with Zyte Smart Proxy Manager

3. Run sample.js using Node

1node sample.js

Zyte SmartProxy Plugin arguments

Argument	Default Value	Description
spm_apikey	undefined	Zyte Smart Proxy Manager API key that can be found on your zyte.com account.
spm_host	http://proxy.zyte.com:8011	Zyte Smart Proxy Manager proxy host.
static_bypass	true	When true Zyte SmartProxy Plugin will skip proxy use (saves proxy bandwidth) for static assets defined by static_bypass_regex or pass false to use proxy.
static_bypass_regex	/.*?\.(?:txt|json|css|less|gif|ico|jpe?g|svg|png|webp|mkv|mp4|mpe?g|webm|eot|ttf|woff2?)$/	Regex to use filtering URLs for static_bypass.
headers	{'X-Crawlera-No-Bancheck': '1', 'X-Crawlera-Profile': 'pass', 'X-Crawlera-Cookies': 'disable'}	List of headers to be appended to requests
spm_session_id	undefined	When specified Zyte SmartProxy Plugin will use an existing Zyte Smart Proxy Manager session, otherwise a new session will be created.

Notes

• Some websites may not work with AdBlocker or static_bypass enabled (default). Try to disable them if you encounter any issues.

• When using headless: true mode, values generated for some browser-specific headers are a bit different, which may be detected by websites. Try using 'X-Crawlera-Profile': 'desktop' in that case:

1puppeteer.use(SmartProxyPlugin({spm_apikey: '<SPM_APIKEY>', headers: {'X-Crawlera-No-Bancheck': '1', 'X-Crawlera-Profile': 'desktop', 'X-Crawlera-Cookies': 'disable'}}));

• When connecting to a remote Chrome browser instance, it should be launched with these arguments:

--proxy-server=http://proxy.zyte.com:8011 --disable-site-isolation-trials