@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
Other
- AddRequestsBatchedOptions
- AddRequestsBatchedResult
- AutoscaledPool
- AutoscaledPoolOptions
- BASIC_CRAWLER_TIMEOUT_BUFFER_SECS
- BLOCKED_STATUS_CODES
- BasicCrawler
- BasicCrawlerOptions
- BasicCrawlingContext
- ClientInfo
- Configuration
- ConfigurationOptions
- Cookie
- CrawlerAddRequestsOptions
- CrawlerAddRequestsResult
- CrawlerExperiments
- CrawlerRunOptions
- CrawlingContext
- CreateContextOptions
- CreateSession
- CriticalError
- Dataset
- DatasetConsumer
- DatasetContent
- DatasetDataOptions
- DatasetExportOptions
- DatasetExportToOptions
- DatasetIteratorOptions
- DatasetMapper
- DatasetOptions
- DatasetReducer
- EnqueueLinksOptions
- EnqueueStrategy
- ErrorHandler
- EventManager
- EventType
- EventTypeName
- FinalStatistics
- GetUserDataFromRequest
- GlobInput
- GlobObject
- HttpCrawler
- HttpCrawlerOptions
- HttpCrawlingContext
- HttpErrorHandler
- HttpHook
- HttpRequestHandler
- IStorage
- KeyConsumer
- KeyValueStore
- KeyValueStoreIteratorOptions
- KeyValueStoreOptions
- LocalEventManager
- Log
- LogLevel
- Logger
- LoggerJson
- LoggerOptions
- LoggerText
- MAX_POOL_SIZE
- NonRetryableError
- PERSIST_STATE_KEY
- PersistenceOptions
- ProxyConfiguration
- ProxyConfigurationFunction
- ProxyConfigurationOptions
- ProxyInfo
- PseudoUrl
- PseudoUrlInput
- PseudoUrlObject
- PushErrorMessageOptions
- QueueOperationInfo
- RecordOptions
- RegExpInput
- RegExpObject
- Request
- RequestHandler
- RequestHandlerResult
- RequestList
- RequestListOptions
- RequestListSourcesFunction
- RequestListState
- RequestOptions
- RequestProvider
- RequestProviderOptions
- RequestQueue
- RequestQueueOperationOptions
- RequestQueueOptions
- RequestQueueV2
- RequestState
- RequestTransform
- RestrictedCrawlingContext
- RetryRequestError
- Router
- RouterHandler
- RouterRoutes
- Session
- SessionError
- SessionOptions
- SessionPool
- SessionPoolOptions
- SessionState
- Snapshotter
- SnapshotterOptions
- Source
- StatisticPersistedState
- StatisticState
- Statistics
- StatisticsOptions
- StatusMessageCallback
- StatusMessageCallbackParams
- StorageClient
- StorageManagerOptions
- SystemInfo
- SystemStatus
- SystemStatusOptions
- UrlPatternObject
- UseStateOptions
- createBasicRouter
- createHttpRouter
- enqueueLinks
- filterRequestsByPatterns
- log
- purgeDefaultStorages
- tryAbsoluteURL
- useState
- CheerioCrawlerOptions
- CheerioCrawlingContext
- CheerioErrorHandler
- CheerioHook
- CheerioRequestHandler
- createCheerioRouter
Other
AddRequestsBatchedOptions
AddRequestsBatchedResult
AutoscaledPool
AutoscaledPoolOptions
BASIC_CRAWLER_TIMEOUT_BUFFER_SECS
BLOCKED_STATUS_CODES
BasicCrawler
BasicCrawlerOptions
BasicCrawlingContext
ClientInfo
Configuration
ConfigurationOptions
Cookie
CrawlerAddRequestsOptions
CrawlerAddRequestsResult
CrawlerExperiments
CrawlerRunOptions
CrawlingContext
CreateContextOptions
CreateSession
CriticalError
Dataset
DatasetConsumer
DatasetContent
DatasetDataOptions
DatasetExportOptions
DatasetExportToOptions
DatasetIteratorOptions
DatasetMapper
DatasetOptions
DatasetReducer
EnqueueLinksOptions
EnqueueStrategy
ErrorHandler
EventManager
EventType
EventTypeName
FinalStatistics
GetUserDataFromRequest
GlobInput
GlobObject
HttpCrawler
HttpCrawlerOptions
HttpCrawlingContext
HttpErrorHandler
HttpHook
HttpRequestHandler
IStorage
KeyConsumer
KeyValueStore
KeyValueStoreIteratorOptions
KeyValueStoreOptions
LocalEventManager
Log
LogLevel
Logger
LoggerJson
LoggerOptions
LoggerText
MAX_POOL_SIZE
NonRetryableError
PERSIST_STATE_KEY
PersistenceOptions
ProxyConfiguration
ProxyConfigurationFunction
ProxyConfigurationOptions
ProxyInfo
PseudoUrl
PseudoUrlInput
PseudoUrlObject
PushErrorMessageOptions
QueueOperationInfo
RecordOptions
RegExpInput
RegExpObject
Request
RequestHandler
RequestHandlerResult
RequestList
RequestListOptions
RequestListSourcesFunction
RequestListState
RequestOptions
RequestProvider
RequestProviderOptions
RequestQueue
RequestQueueOperationOptions
RequestQueueOptions
RequestQueueV2
RequestState
RequestTransform
RestrictedCrawlingContext
RetryRequestError
Router
RouterHandler
RouterRoutes
Session
SessionError
SessionOptions
SessionPool
SessionPoolOptions
SessionState
Snapshotter
SnapshotterOptions
Source
StatisticPersistedState
StatisticState
Statistics
StatisticsOptions
StatusMessageCallback
StatusMessageCallbackParams
StorageClient
StorageManagerOptions
SystemInfo
SystemStatus
SystemStatusOptions
UrlPatternObject
UseStateOptions
createBasicRouter
createHttpRouter
enqueueLinks
filterRequestsByPatterns
log
purgeDefaultStorages
tryAbsoluteURL
useState
CheerioErrorHandler
Type parameters
- UserData: Dictionary = any
- JSONData: Dictionary = any
CheerioHook
Type parameters
- UserData: Dictionary = any
- JSONData: Dictionary = any
CheerioRequestHandler
Type parameters
- UserData: Dictionary = any
- JSONData: Dictionary = any