Skip to main content
Version: Next

@crawlee/cheerio

Provides a framework for the parallel crawling of web pages using plain HTTP requests and cheerio HTML parser. The URLs to crawl are fed either from a static list of URLs or from a dynamic queue of URLs enabling recursive crawling of websites.

Since CheerioCrawler uses raw HTTP requests to download web pages, it is very fast and efficient on data bandwidth. However, if the target website requires JavaScript to display the content, you might need to use PuppeteerCrawler or PlaywrightCrawler instead, because it loads the pages using full-featured headless Chrome browser.

CheerioCrawler downloads each URL using a plain HTTP request, parses the HTML content using Cheerio and then invokes the user-provided CheerioCrawlerOptions.requestHandler to extract page data using a jQuery-like interface to the parsed HTML DOM.

The source URLs are represented using Request objects that are fed from RequestList or RequestQueue instances provided by the CheerioCrawlerOptions.requestList or CheerioCrawlerOptions.requestQueue constructor options, respectively.

If both CheerioCrawlerOptions.requestList and CheerioCrawlerOptions.requestQueue are used, the instance first processes URLs from the RequestList and automatically enqueues all of them to RequestQueue before it starts their processing. This ensures that a single URL is not crawled multiple times.

The crawler finishes when there are no more Request objects to crawl.

We can use the preNavigationHooks to adjust gotOptions:

preNavigationHooks: [
(crawlingContext, gotOptions) => {
// ...
},
]

By default, CheerioCrawler only processes web pages with the text/html and application/xhtml+xml MIME content types (as reported by the Content-Type HTTP header), and skips pages with other content types. If you want the crawler to process other content types, use the CheerioCrawlerOptions.additionalMimeTypes constructor option. Beware that the parsing behavior differs for HTML, XML, JSON and other types of content. For more details, see CheerioCrawlerOptions.requestHandler.

New requests are only dispatched when there is enough free CPU and memory available, using the functionality provided by the AutoscaledPool class. All AutoscaledPool configuration options can be passed to the autoscaledPoolOptions parameter of the CheerioCrawler constructor. For user convenience, the minConcurrency and maxConcurrency AutoscaledPool options are available directly in the CheerioCrawler constructor.

Example usage‚Äč

const crawler = new CheerioCrawler({
requestList,
async requestHandler({ request, response, body, contentType, $ }) {
const data = [];

// Do some data extraction from the page with Cheerio.
$('.some-collection').each((index, el) => {
data.push({ title: $(el).find('.some-title').text() });
});

// Save the data to dataset.
await Dataset.pushData({
url: request.url,
html: body,
data,
})
},
});

await crawler.run([
'http://www.example.com/page-1',
'http://www.example.com/page-2',
]);

Index

Crawlers

Functions

Interfaces

References

Type Aliases

References

AutoscaledPool

Re-exports AutoscaledPool

AutoscaledPoolOptions

BASIC_CRAWLER_TIMEOUT_BUFFER_SECS

BasicCrawler

Re-exports BasicCrawler

BasicCrawlerOptions

BasicCrawlingContext

ClientInfo

Re-exports ClientInfo

Configuration

Re-exports Configuration

ConfigurationOptions

Cookie

Re-exports Cookie

CrawlerAddRequestsOptions

CrawlerAddRequestsResult

CrawlingContext

Re-exports CrawlingContext

CreateContextOptions

CreateSession

Re-exports CreateSession

CriticalError

Re-exports CriticalError

Dataset

Re-exports Dataset

DatasetConsumer

Re-exports DatasetConsumer

DatasetContent

Re-exports DatasetContent

DatasetDataOptions

DatasetIteratorOptions

DatasetMapper

Re-exports DatasetMapper

DatasetOptions

Re-exports DatasetOptions

DatasetReducer

Re-exports DatasetReducer

EnqueueLinksOptions

EnqueueStrategy

Re-exports EnqueueStrategy

ErrorHandler

Re-exports ErrorHandler

EventManager

Re-exports EventManager

EventType

Re-exports EventType

EventTypeName

Re-exports EventTypeName

ExportOptions

Re-exports ExportOptions

FinalStatistics

Re-exports FinalStatistics

GlobInput

Re-exports GlobInput

GlobObject

Re-exports GlobObject

HttpCrawler

Re-exports HttpCrawler

HttpCrawlerOptions

HttpCrawlingContext

HttpErrorHandler

Re-exports HttpErrorHandler

HttpHook

Re-exports HttpHook

HttpRequestHandler

IStorage

Re-exports IStorage

KeyConsumer

Re-exports KeyConsumer

KeyValueStore

Re-exports KeyValueStore

KeyValueStoreIteratorOptions

KeyValueStoreOptions

LocalEventManager

Log

Re-exports Log

LogLevel

Re-exports LogLevel

Logger

Re-exports Logger

LoggerJson

Re-exports LoggerJson

LoggerOptions

Re-exports LoggerOptions

LoggerText

Re-exports LoggerText

NonRetryableError

ProxyConfiguration

ProxyConfigurationFunction

ProxyConfigurationOptions

ProxyInfo

Re-exports ProxyInfo

PseudoUrl

Re-exports PseudoUrl

PseudoUrlInput

Re-exports PseudoUrlInput

PseudoUrlObject

Re-exports PseudoUrlObject

PushErrorMessageOptions

QueueOperationInfo

QueueOperationInfoOptions

RecordOptions

Re-exports RecordOptions

RegExpInput

Re-exports RegExpInput

RegExpObject

Re-exports RegExpObject

Request

Re-exports Request

RequestHandler

Re-exports RequestHandler

RequestList

Re-exports RequestList

RequestListOptions

RequestListSourcesFunction

RequestListState

Re-exports RequestListState

RequestOptions

Re-exports RequestOptions

RequestQueue

Re-exports RequestQueue

RequestQueueOperationOptions

RequestQueueOptions

RequestState

Re-exports RequestState

RequestTransform

Re-exports RequestTransform

RetryRequestError

Router

Re-exports Router

RouterHandler

Re-exports RouterHandler

Session

Re-exports Session

SessionOptions

Re-exports SessionOptions

SessionPool

Re-exports SessionPool

SessionPoolOptions

SessionState

Re-exports SessionState

Snapshotter

Re-exports Snapshotter

SnapshotterOptions

Source

Re-exports Source

StatisticPersistedState

StatisticState

Re-exports StatisticState

Statistics

Re-exports Statistics

StorageClient

Re-exports StorageClient

StorageManagerOptions

SystemInfo

Re-exports SystemInfo

SystemStatus

Re-exports SystemStatus

SystemStatusOptions

UrlPatternObject

Re-exports UrlPatternObject

UseStateOptions

Re-exports UseStateOptions

createBasicRouter

createHttpRouter

Re-exports createHttpRouter

enqueueLinks

Re-exports enqueueLinks

filterRequestsByPatterns

log

Re-exports log

purgeDefaultStorages

useState

Re-exports useState

Type Aliases

CheerioErrorHandler

CheerioErrorHandler<UserData, JSONData>: ErrorHandler<CheerioCrawlingContext<UserData, JSONData>>

Type parameters

  • UserData: Dictionary = any
  • JSONData: Dictionary = any

CheerioHook

CheerioHook<UserData, JSONData>: InternalHttpHook<CheerioCrawlingContext<UserData, JSONData>>

Type parameters

  • UserData: Dictionary = any
  • JSONData: Dictionary = any

CheerioRequestHandler

CheerioRequestHandler<UserData, JSONData>: RequestHandler<CheerioCrawlingContext<UserData, JSONData>>

Type parameters

  • UserData: Dictionary = any
  • JSONData: Dictionary = any