Back to template gallery

Crawlee + Cheerio

A scraper example that uses Cheerio to parse HTML. It's fast, but it can't run the website's JavaScript or pass JS anti-scraping challenges.







Use cases

Web scraping


1// Apify SDK - toolkit for building Apify Actors (Read more at
2import { Actor } from 'apify';
3// Crawlee - web scraping and browser automation library (Read more at
4import { CheerioCrawler, Dataset } from 'crawlee';
5// this is ESM project, and as such, it requires you to specify extensions in your relative imports
6// read more about this here:
7// note that we need to use `.js` even when inside TS files
8// import { router } from './routes.js';
10interface Input {
11    startUrls: string[];
12    maxRequestsPerCrawl: number;
15// The init() call configures the Actor for its environment. It's recommended to start every Actor with an init()
16await Actor.init();
18// Structure of input is defined in input_schema.json
19const {
20    startUrls = [''],
21    maxRequestsPerCrawl = 100,
22} = await Actor.getInput<Input>() ?? {} as Input;
24const proxyConfiguration = await Actor.createProxyConfiguration();
26const crawler = new CheerioCrawler({
27    proxyConfiguration,
28    maxRequestsPerCrawl,
29    requestHandler: async ({ enqueueLinks, request, $, log }) => {
30'enqueueing new URLs');
31        await enqueueLinks();
33        // Extract title from the page.
34        const title = $('title').text();
35`${title}`, { url: request.loadedUrl });
37        // Save url and title to Dataset - a table-like storage.
38        await Dataset.pushData({ url: request.loadedUrl, title });
39    },
44// Gracefully exit the Actor process. It's recommended to quit all Actors with an exit()
45await Actor.exit();

TypeScript Crawlee & CheerioCrawler template

A template example built with Crawlee to scrape data from a website using Cheerio wrapped into CheerioCrawler.

Included features

  • Apify SDK - toolkit for building Actors
  • Crawlee - web scraping and browser automation library
  • 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
  • Cheerio - a fast, flexible & elegant library for parsing and manipulating HTML and XML

How it works

This code is a TypeScript script that uses Crawlee CheerioCralwer framework to crawl a website and extract the data from the crawled URLs with Cheerio. It then stores the website titles in a dataset.

  • The crawler starts with URLs provided from the input startUrls field defined by the input schema. Number of scraped pages is limited by maxPagesPerCrawl field from input schema.
  • The crawler uses requestHandler for each URL to extract the data from the page with the Cheerio library and to save the title and URL of each page to the dataset. It also logs out each result that is being saved.


Already have a solution in mind?

Sign up for a free Apify account and deploy your code to the platform in just a few minutes! If you want a head start without coding it yourself, browse our Store of existing solutions.