TypeScript PuppeteerCrawler Actor template

This template is a production ready boilerplate for developing with PuppeteerCrawler. The PuppeteerCrawler provides a simple framework for parallel crawling of web pages using headless Chrome with Puppeteer. Since PuppeteerCrawler uses headless Chrome to download web pages and extract data, it is useful for crawling of websites that require to execute JavaScript.

If you're looking for examples or want to learn more visit:

• Crawlee + Apify Platform guide
• Examples

Included features

• Puppeteer Crawler - simple framework for parallel crawling of web pages using headless Chrome with Puppeteer
• Configurable Proxy - tool for working around IP blocking
• Input schema - define and easily validate a schema for your Actor's input
• Dataset - store structured data where each object stored has the same attributes
• Apify SDK - toolkit for building Actors

How it works

1. Actor.getInput() gets the input from INPUT.json where the start urls are defined
2. Create a configuration for proxy servers to be used during the crawling with Actor.createProxyConfiguration() to work around IP blocking. Use Apify Proxy or your own Proxy URLs provided and rotated according to the configuration. You can read more about proxy configuration here.
3. Create an instance of Crawlee's Puppeteer Crawler with new PuppeteerCrawler(). You can pass options to the crawler constructor as:
   • proxyConfiguration - provide the proxy configuration to the crawler
   • requestHandler - handle each request with custom router defined in the routes.js file.
4. Handle requests with the custom router from routes.js file. Read more about custom routing for the Cheerio Crawler here
   • Create a new router instance with new createPuppeteerRouter()
   • Define default handler that will be called for all URLs that are not handled by other handlers by adding router.addDefaultHandler(() => { ... })
   • Define additional handlers - here you can add your own handling of the page

     1router.addHandler('detail', async ({ request, page, log }) => {
     2    const title = await page.title();
     3    // You can add your own page handling here
     4
     5    await Dataset.pushData({
     6        url: request.loadedUrl,
     7        title,
     8    });
     9});
     

5. crawler.run(startUrls); start the crawler and wait for its finish

Resources

If you're looking for examples or want to learn more visit:

• Crawlee + Apify Platform guide
• Documentation and examples
• Node.js tutorials in Academy
• How to scale Puppeteer and Playwright
• Video guide on getting data using Apify API
• Integration with Make, GitHub, Zapier, Google Drive, and other apps
• A short guide on how to build web scrapers using code templates:

Getting started

For complete information see this article. In short, you will:

1. Build the Actor
2. Run the Actor

Pull the Actor for local development

If you would like to develop locally, you can pull the existing Actor from Apify console using Apify CLI:

1. Install apify-cli

   Using Homebrew

   brew install apify-cli
   

   Using NPM

   npm -g install apify-cli
   

2. Pull the Actor by its unique <ActorId>, which is one of the following:

   • unique name of the Actor to pull (e.g. "apify/hello-world")
   • or ID of the Actor to pull (e.g. "E2jjCZBezvAZnX8Rb")

   You can find both by clicking on the Actor title at the top of the page, which will open a modal containing both Actor unique name and Actor ID.

   This command will copy the Actor into the current directory on your local machine.

   apify pull <ActorId>
   

Documentation reference

To learn more about Apify and Actors, take a look at the following resources:

• Apify SDK for JavaScript documentation
• Apify SDK for Python documentation
• Apify Platform documentation
• Join our developer community on Discord