Skip to main content
Version: Next

@crawlee/browser

Provides a simple framework for parallel crawling of web pages using headless browsers with Puppeteer and Playwright. 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 BrowserCrawler uses headless (or even headful) browsers to download web pages and extract data, it is useful for crawling of websites that require to execute JavaScript. If the target website doesn't need JavaScript, we should consider using the CheerioCrawler, which downloads the pages using raw HTTP requests and is about 10x faster.

The source URLs are represented by the Request objects that are fed from the RequestList or RequestQueue instances provided by the requestList or requestQueue constructor options, respectively. If neither requestList nor requestQueue options are provided, the crawler will open the default request queue either when the crawler.addRequests() function is called, or if requests parameter (representing the initial requests) of the crawler.run() function is provided.

If both requestList and requestQueue options are used, the instance first processes URLs from the RequestList and automatically enqueues all of them to the 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.

BrowserCrawler opens a new browser page (i.e. tab or window) for each Request object to crawl and then calls the function provided by user as the requestHandler option.

New pages are only opened when there is enough free CPU and memory available, as judged by the crawler's ConcurrencySystem. Concurrency is tuned via the minConcurrency, maxConcurrency and maxRequestsPerMinute options of the BrowserCrawler constructor, or, for finer control, by injecting a pre-configured concurrencySystem.

NOTE: the pool of browser instances is internally managed by the BrowserPool class.

Index

Crawlers

Other

Other

AddRequestsBatchedOptions

Re-exports AddRequestsBatchedOptions

AddRequestsBatchedResult

Re-exports AddRequestsBatchedResult

ApifyLogAdapter

Re-exports ApifyLogAdapter

ArgumentValidationError

Re-exports ArgumentValidationError

BaseCrawleeLogger

Re-exports BaseCrawleeLogger

BasicCrawler

Re-exports BasicCrawler

BasicCrawlerOptions

Re-exports BasicCrawlerOptions

BasicCrawlingContext

Re-exports BasicCrawlingContext

BLOCKED_STATUS_CODES

Re-exports BLOCKED_STATUS_CODES

CalculatedStatistics

Re-exports CalculatedStatistics

coerceBoolean

Re-exports coerceBoolean

coerceNumber

Re-exports coerceNumber

ConcurrencyConsumer

Re-exports ConcurrencyConsumer

ConcurrencySystem

Re-exports ConcurrencySystem

ConcurrencySystemOptions

Re-exports ConcurrencySystemOptions

ConfigField

Re-exports ConfigField

Configuration

Re-exports Configuration

ConfigurationInput

Re-exports ConfigurationInput

ConfigurationOptions

Re-exports ConfigurationOptions

ContextMiddleware

Re-exports ContextMiddleware

ContextPipeline

Re-exports ContextPipeline

ContextPipelineCleanupError

Re-exports ContextPipelineCleanupError

ContextPipelineInitializationError

Re-exports ContextPipelineInitializationError

ContextPipelineInterruptedError

Re-exports ContextPipelineInterruptedError

CpuLoadSignal

Re-exports CpuLoadSignal

CpuLoadSignalOptions

Re-exports CpuLoadSignalOptions

crawleeConfigFields

Re-exports crawleeConfigFields

CrawleeLogger

Re-exports CrawleeLogger

CrawleeLoggerOptions

Re-exports CrawleeLoggerOptions

CrawlerAddRequestsOptions

Re-exports CrawlerAddRequestsOptions

CrawlerAddRequestsResult

Re-exports CrawlerAddRequestsResult

CrawlerRunOptions

Re-exports CrawlerRunOptions

CrawlingContext

Re-exports CrawlingContext

createBasicRouter

Re-exports createBasicRouter

CreateContextOptions

Re-exports CreateContextOptions

CreateSession

Re-exports CreateSession

createStorageTransaction

Re-exports createStorageTransaction

CriticalError

Re-exports CriticalError

Dataset

Re-exports Dataset

DatasetConsumer

Re-exports DatasetConsumer

DatasetContent

Re-exports DatasetContent

DatasetDataOptions

Re-exports DatasetDataOptions

DatasetExportOptions

Re-exports DatasetExportOptions

DatasetExportToOptions

Re-exports DatasetExportToOptions

DatasetIteratorOptions

Re-exports DatasetIteratorOptions

DatasetJournalEntry

Re-exports DatasetJournalEntry

DatasetMapper

Re-exports DatasetMapper

DatasetOptions

Re-exports DatasetOptions

DatasetReducer

Re-exports DatasetReducer

DatasetStats

Re-exports DatasetStats

defaultRoute

Re-exports defaultRoute

DefaultRouteUserData

Re-exports DefaultRouteUserData

DefaultStorageIdentifier

Re-exports DefaultStorageIdentifier

EnqueueLinksOptions

Re-exports EnqueueLinksOptions

EnqueueStrategy

Re-exports EnqueueStrategy

EnqueueStrategyOption

Re-exports EnqueueStrategyOption

EnqueueUrlsOptions

Re-exports EnqueueUrlsOptions

ErrnoException

Re-exports ErrnoException

ErrorHandler

Re-exports ErrorHandler

ErrorSnapshotter

Re-exports ErrorSnapshotter

ErrorTracker

Re-exports ErrorTracker

ErrorTrackerOptions

Re-exports ErrorTrackerOptions

EventLoopLoadSignal

Re-exports EventLoopLoadSignal

EventLoopLoadSignalOptions

Re-exports EventLoopLoadSignalOptions

EventManager

Re-exports EventManager

EventManagerOptions

Re-exports EventManagerOptions

EventStatusMessageData

Re-exports EventStatusMessageData

EventType

Re-exports EventType

EventTypeName

Re-exports EventTypeName

ExplicitStorageIdentifier

Re-exports ExplicitStorageIdentifier

ExtractLinksOptions

Re-exports ExtractLinksOptions

field

Re-exports field

FieldsInput

Re-exports FieldsInput

FieldsOutput

Re-exports FieldsOutput

FinalStatistics

Re-exports FinalStatistics

GetUserDataFromRequest

Re-exports GetUserDataFromRequest

GlobInput

Re-exports GlobInput

GlobObject

Re-exports GlobObject

IConcurrencySystem

Re-exports IConcurrencySystem

IProxyConfiguration

Re-exports IProxyConfiguration

IRequestLoader

Re-exports IRequestLoader

IRequestManager

Re-exports IRequestManager

IStatistics

Re-exports IStatistics

IStorage

Re-exports IStorage

JournaledRequest

Re-exports JournaledRequest

JournalEntry

Re-exports JournalEntry

KeyConsumer

Re-exports KeyConsumer

KeyValueStore

Re-exports KeyValueStore

KeyValueStoreIteratorOptions

Re-exports KeyValueStoreIteratorOptions

KeyValueStoreJournalEntry

Re-exports KeyValueStoreJournalEntry

KeyValueStoreOptions

Re-exports KeyValueStoreOptions

KeyValueStoreRawRecord

Re-exports KeyValueStoreRawRecord

KeyValueStoreStats

Re-exports KeyValueStoreStats

LabeledSource

Re-exports LabeledSource

LoadedRequest

Re-exports LoadedRequest

LoadSignal

Re-exports LoadSignal

LoadSignalInfo

Re-exports LoadSignalInfo

LoadSignalsOptions

Re-exports LoadSignalsOptions

LoadSignalStartContext

Re-exports LoadSignalStartContext

LoadSnapshot

Re-exports LoadSnapshot

LocalEventManager

Re-exports LocalEventManager

LocalEventManagerOptions

Re-exports LocalEventManagerOptions

log

Re-exports log

Log

Re-exports Log

Logger

Re-exports Logger

LoggerJson

Re-exports LoggerJson

LoggerOptions

Re-exports LoggerOptions

LoggerText

Re-exports LoggerText

LogLevel

Re-exports LogLevel

MAX_POOL_SIZE

Re-exports MAX_POOL_SIZE

MemoryLoadSignal

Re-exports MemoryLoadSignal

MemoryLoadSignalOptions

Re-exports MemoryLoadSignalOptions

MemoryStorageBackend

Re-exports MemoryStorageBackend

MemoryStorageOptions

Re-exports MemoryStorageOptions

MissingSessionError

Re-exports MissingSessionError

NavigationSkippedError

Re-exports NavigationSkippedError

NonRetryableError

Re-exports NonRetryableError

PacingScope

Re-exports PacingScope

PacingSignal

Re-exports PacingSignal

parseRetryAfterHeader

Re-exports parseRetryAfterHeader

parseValue

Re-exports parseValue

PERSIST_STATE_KEY

Re-exports PERSIST_STATE_KEY

PersistenceOptions

Re-exports PersistenceOptions

PersistentRateLimitError

Re-exports PersistentRateLimitError

ProxyConfiguration

Re-exports ProxyConfiguration

ProxyConfigurationFunction

Re-exports ProxyConfigurationFunction

ProxyConfigurationOptions

Re-exports ProxyConfigurationOptions

purgeDefaultStorages

Re-exports purgeDefaultStorages

PushErrorMessageOptions

Re-exports PushErrorMessageOptions

RecordOptions

Re-exports RecordOptions

RecoverableState

Re-exports RecoverableState

RecoverableStateOptions

Re-exports RecoverableStateOptions

RecoverableStatePersistenceOptions

Re-exports RecoverableStatePersistenceOptions

RegExpInput

Re-exports RegExpInput

RegExpObject

Re-exports RegExpObject

Request

Re-exports Request

RequestHandler

Re-exports RequestHandler

RequestHandlerError

Re-exports RequestHandlerError

RequestList

Re-exports RequestList

RequestListOptions

Re-exports RequestListOptions

RequestListSourcesFunction

Re-exports RequestListSourcesFunction

RequestListState

Re-exports RequestListState

RequestLoaderStatus

Re-exports RequestLoaderStatus

RequestManagerOpener

Re-exports RequestManagerOpener

RequestManagerTandem

Re-exports RequestManagerTandem

RequestOptions

Re-exports RequestOptions

RequestQueue

Re-exports RequestQueue

RequestQueueJournalEntry

Re-exports RequestQueueJournalEntry

RequestQueueOperationInfo

Re-exports RequestQueueOperationInfo

RequestQueueOperationOptions

Re-exports RequestQueueOperationOptions

RequestQueueOptions

Re-exports RequestQueueOptions

RequestQueueStats

Re-exports RequestQueueStats

RequestsLike

Re-exports RequestsLike

RequestSourceStatus

Re-exports RequestSourceStatus

RequestState

Re-exports RequestState

RequestThrottledError

Re-exports RequestThrottledError

RequestTransform

Re-exports RequestTransform

RequestValidationError

Re-exports RequestValidationError

RequireContextPipeline

Re-exports RequireContextPipeline

ResolvedConfigValues

Re-exports ResolvedConfigValues

resolveStorageIdentifier

Re-exports resolveStorageIdentifier

ResponseLike

Re-exports ResponseLike

RestrictedCrawlingContext

Re-exports RestrictedCrawlingContext

RetryRequestError

Re-exports RetryRequestError

RouteOptions

Re-exports RouteOptions

Router

Re-exports Router

RouterHandler

Re-exports RouterHandler

RouterHandlerContext

Re-exports RouterHandlerContext

RouterLabel

Re-exports RouterLabel

RouterRoutes

Re-exports RouterRoutes

RouteSchemas

Re-exports RouteSchemas

RoutesFromSchemas

Re-exports RoutesFromSchemas

SchemaIssue

Re-exports SchemaIssue

serializeValue

Re-exports serializeValue

ServiceConflictError

Re-exports ServiceConflictError

serviceLocator

Re-exports serviceLocator

ServiceLocator

Re-exports ServiceLocator

Session

Re-exports Session

SessionError

Re-exports SessionError

SessionOptions

Re-exports SessionOptions

SessionPool

Re-exports SessionPool

SessionPoolOptions

Re-exports SessionPoolOptions

SessionReuseStrategy

Re-exports SessionReuseStrategy

SitemapRequestLoader

Re-exports SitemapRequestLoader

SitemapRequestLoaderOptions

Re-exports SitemapRequestLoaderOptions

SkippedRequestCallback

Re-exports SkippedRequestCallback

SkippedRequestReason

Re-exports SkippedRequestReason

SnapshotResult

Re-exports SnapshotResult

SnapshotStore

Re-exports SnapshotStore

Source

Re-exports Source

StateConversion

Re-exports StateConversion

StateValidationError

Re-exports StateValidationError

StatisticPersistedState

Re-exports StatisticPersistedState

Statistics

Re-exports Statistics

StatisticsOptions

Re-exports StatisticsOptions

StatisticState

Re-exports StatisticState

StatisticStateExtensionOptions

Re-exports StatisticStateExtensionOptions

StatusMessageCallback

Re-exports StatusMessageCallback

StatusMessageCallbackParams

Re-exports StatusMessageCallbackParams

StorageBackend

Re-exports StorageBackend

StorageBackendLoadSignal

Re-exports StorageBackendLoadSignal

StorageBackendLoadSignalOptions

Re-exports StorageBackendLoadSignalOptions

StorageIdentifier

Re-exports StorageIdentifier

StorageInstanceManager

Re-exports StorageInstanceManager

StorageOpenOptions

Re-exports StorageOpenOptions

StorageStatsTracker

Re-exports StorageStatsTracker

StorageTransaction

Re-exports StorageTransaction

StorageTransactionOptions

Re-exports StorageTransactionOptions

StorageTransactionState

Re-exports StorageTransactionState

StorageTransactionView

Re-exports StorageTransactionView

StorageWriteMode

Re-exports StorageWriteMode

StorageWritePolicy

Re-exports StorageWritePolicy

SyncStateConversion

Re-exports SyncStateConversion

SystemInfo

Re-exports SystemInfo

TaskLoopOptions

Re-exports TaskLoopOptions

TaskLoopPredicates

Re-exports TaskLoopPredicates

ThrottlingRequestManager

Re-exports ThrottlingRequestManager

ThrottlingRequestManagerOptions

Re-exports ThrottlingRequestManagerOptions

TypedContextAddRequests

Re-exports TypedContextAddRequests

TypedContextEnqueueLinks

Re-exports TypedContextEnqueueLinks

UrlPatternInput

Re-exports UrlPatternInput

UrlPatternObject

Re-exports UrlPatternObject

useState

Re-exports useState

UseStateOptions

Re-exports UseStateOptions

withDirectStorageAccess

Re-exports withDirectStorageAccess

WithRequired

Re-exports WithRequired

withStorageTransaction

Re-exports withStorageTransaction

BrowserHook

BrowserHook<Context, ContextExtension>: (crawlingContext) => Awaitable<void | Partial<Context>>

Type parameters

Type declaration

    • (crawlingContext): Awaitable<void | Partial<Context>>

    • Parameters

      • crawlingContext: Context & ContextExtension

      Returns Awaitable<void | Partial<Context>>

LauncherBrowserPoolOptions

LauncherBrowserPoolOptions: Omit<BrowserPoolOptions, browserPlugins> & { [ Hook in keyof BrowserPoolHooks<any, any, any> ]?: readonly (...args) => unknown[] }

The BrowserPool options a launcher-built pool accepts: everything the pool itself takes except browserPlugins, which the launcher derives from its launch context. The hooks are deliberately unconstrained - the browser they run against is only known to the concrete *BrowserPool() factory, which is where the caller-facing types are pinned down.

LauncherRemoteBrowserPoolOptions

LauncherRemoteBrowserPoolOptions: Omit<RemoteBrowserPoolOptions, browserPlugins>

The RemoteBrowserPool counterpart of LauncherBrowserPoolOptions.

OwnedBrowserPool

OwnedBrowserPool<Page>: IBrowserPool<Page> & { destroy: () => Promise<void> }

The type of a browser pool the crawler builds (and therefore owns) for itself. It's an IBrowserPool that additionally exposes destroy() — the crawler only ever tears down pools it created, which is why IBrowserPool itself intentionally omits destroy.

Type parameters

  • Page
Page Options