Skip to main content
Version: 3.12

Proxy Management

IP address blocking is one of the oldest and most effective ways of preventing access to a website. It is therefore paramount for a good web scraping library to provide easy to use but powerful tools which can work around IP blocking. The most powerful weapon in our anti IP blocking arsenal is a proxy server.

With Crawlee we can use our own proxy servers or proxy servers acquired from third-party providers.

Check out the avoid blocking guide for more information about blocking.

Quick start​

If we already have proxy URLs of our own, we can start using them immediately in only a few lines of code.

import { ProxyConfiguration } from 'crawlee';

const proxyConfiguration = new ProxyConfiguration({
    proxyUrls: [
        'http://proxy-1.com',
        'http://proxy-2.com',
    ]
});
const proxyUrl = await proxyConfiguration.newUrl();

Examples of how to use our proxy URLs with crawlers are shown below in Crawler integration section.

Proxy Configuration​

All our proxy needs are managed by the ProxyConfiguration class. We create an instance using the ProxyConfiguration constructor function based on the provided options. See the ProxyConfigurationOptions for all the possible constructor options.

Static proxy list​

You can provide a static list of proxy URLs to the proxyUrls option. The ProxyConfiguration will then rotate through the provided proxies.

const proxyConfiguration = new ProxyConfiguration({
    proxyUrls: [
        'http://proxy-1.com',
        'http://proxy-2.com',
        null // null means no proxy is used
    ]
});

This is the simplest way to use a list of proxies. Crawlee will rotate through the list of proxies in a round-robin fashion.

Custom proxy function​

The ProxyConfiguration class allows you to provide a custom function to pick a proxy URL. This is useful when you want to implement your own logic for selecting a proxy.

const proxyConfiguration = new ProxyConfiguration({
    newUrlFunction: (sessionId, { request }) => {
        if (request?.url.includes('crawlee.dev')) {
            return null; // for crawlee.dev, we don't use a proxy
        }

        return 'http://proxy-1.com'; // for all other URLs, we use this proxy
    }
});

The newUrlFunction receives two parameters - sessionId and options - and returns a string containing the proxy URL.

The sessionId parameter is always provided and allows us to differentiate between different sessions - e.g. when Crawlee recognizes your crawlers are being blocked, it will automatically create a new session with a different id.

The options parameter is an object containing a Request, which is the request that will be made. Note that this object is not always available, for example when we are using the newUrl function directly. Your custom function should therefore not rely on the request object being present and provide a default behavior when it is not.

Tiered proxies​

You can also provide a list of proxy tiers to the ProxyConfiguration class. This is useful when you want to switch between different proxies automatically based on the blocking behavior of the website.

warning

Note that the tieredProxyUrls option requires ProxyConfiguration to be used from a crawler instance (see below).

Using this configuration through the newUrl calls will not yield the expected results.

const proxyConfiguration = new ProxyConfiguration({
    tieredProxyUrls: [
        [null], // At first, we try to connect without a proxy
        ['http://okay-proxy.com'],
        ['http://slightly-better-proxy.com', 'http://slightly-better-proxy-2.com'],
        ['http://very-good-and-expensive-proxy.com'],
    ]
});

This configuration will start with no proxy, then switch to http://okay-proxy.com if Crawlee recognizes we're getting blocked by the target website. If that proxy is also blocked, we will switch to one of the slightly-better-proxy URLs. If those are blocked, we will switch to the very-good-and-expensive-proxy.com URL.

Crawlee also periodically probes lower tier proxies to see if they are unblocked, and if they are, it will switch back to them.

Crawler integration​

ProxyConfiguration integrates seamlessly into HttpCrawler, CheerioCrawler, JSDOMCrawler, PlaywrightCrawler and PuppeteerCrawler.

import { CheerioCrawler, ProxyConfiguration } from 'crawlee';

const proxyConfiguration = new ProxyConfiguration({
    proxyUrls: ['http://proxy-1.com', 'http://proxy-2.com'],
});

const crawler = new CheerioCrawler({
    proxyConfiguration,
    // ...
});

Our crawlers will now use the selected proxies for all connections.

IP Rotation and session management​

​proxyConfiguration.newUrl() allows us to pass a sessionId parameter. It will then be used to create a sessionId-proxyUrl pair, and subsequent newUrl() calls with the same sessionId will always return the same proxyUrl. This is extremely useful in scraping, because we want to create the impression of a real user. See the session management guide and SessionPool class for more information on how keeping a real session helps us avoid blocking.

When no sessionId is provided, our proxy URLs are rotated round-robin.

import { CheerioCrawler, ProxyConfiguration } from 'crawlee';

const proxyConfiguration = new ProxyConfiguration({
    /* opts */
});

const crawler = new CheerioCrawler({
    useSessionPool: true,
    persistCookiesPerSession: true,
    proxyConfiguration,
    // ...
});

Inspecting current proxy in Crawlers​

HttpCrawler, CheerioCrawler, JSDOMCrawler, PlaywrightCrawler and PuppeteerCrawler grant access to information about the currently used proxy in their requestHandler using a proxyInfo object. With the proxyInfo object, we can easily access the proxy URL.

import { CheerioCrawler, ProxyConfiguration } from 'crawlee';

const proxyConfiguration = new ProxyConfiguration({
    /* opts */
});

const crawler = new CheerioCrawler({
    proxyConfiguration,
    async requestHandler({ proxyInfo }) {
        console.log(proxyInfo);
    },
    // ...
});