Skip to main content
Version: Next

@crawlee/http

Provides a framework for the parallel crawling of web pages using plain HTTP requests. 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.

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. This crawler downloads each URL using a plain HTTP request and doesn't do any HTML parsing.

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

If both HttpCrawlerOptions.requestList and HttpCrawlerOptions.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, HttpCrawler 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 HttpCrawlerOptions.additionalMimeTypes constructor option. Beware that the parsing behavior differs for HTML, XML, JSON and other types of content. For more details, see HttpCrawlerOptions.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 HttpCrawler constructor. For user convenience, the minConcurrency and maxConcurrency AutoscaledPool options are available directly in the HttpCrawler constructor.

Example usage​

import { HttpCrawler, Dataset } from '@crawlee/http';

const crawler = new HttpCrawler({
    requestList,
    async requestHandler({ request, response, body, contentType }) {
        // Save the data to dataset.
        await Dataset.pushData({
            url: request.url,
            html: body,
        });
    },
});

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

Index

Crawlers

Other

Other

AddRequestsBatchedOptions

Re-exports AddRequestsBatchedOptions

AddRequestsBatchedResult

Re-exports AddRequestsBatchedResult

AutoscaledPool

Re-exports AutoscaledPool

AutoscaledPoolOptions

Re-exports AutoscaledPoolOptions

BaseHttpClient

Re-exports BaseHttpClient

BaseHttpResponseData

Re-exports BaseHttpResponseData

BASIC_CRAWLER_TIMEOUT_BUFFER_SECS

Re-exports BASIC_CRAWLER_TIMEOUT_BUFFER_SECS

BasicCrawler

Re-exports BasicCrawler

BasicCrawlerOptions

Re-exports BasicCrawlerOptions

BasicCrawlingContext

Re-exports BasicCrawlingContext

BLOCKED_STATUS_CODES

Re-exports BLOCKED_STATUS_CODES

checkStorageAccess

Re-exports checkStorageAccess

ClientInfo

Re-exports ClientInfo

Configuration

Re-exports Configuration

ConfigurationOptions

Re-exports ConfigurationOptions

Cookie

Re-exports Cookie

CrawlerAddRequestsOptions

Re-exports CrawlerAddRequestsOptions

CrawlerAddRequestsResult

Re-exports CrawlerAddRequestsResult

CrawlerExperiments

Re-exports CrawlerExperiments

CrawlerRunOptions

Re-exports CrawlerRunOptions

CrawlingContext

Re-exports CrawlingContext

createBasicRouter

Re-exports createBasicRouter

CreateContextOptions

Re-exports CreateContextOptions

CreateSession

Re-exports CreateSession

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

DatasetMapper

Re-exports DatasetMapper

DatasetOptions

Re-exports DatasetOptions

DatasetReducer

Re-exports DatasetReducer

enqueueLinks

Re-exports enqueueLinks

EnqueueLinksOptions

Re-exports EnqueueLinksOptions

EnqueueStrategy

Re-exports EnqueueStrategy

ErrnoException

Re-exports ErrnoException

ErrorHandler

Re-exports ErrorHandler

ErrorSnapshotter

Re-exports ErrorSnapshotter

ErrorTracker

Re-exports ErrorTracker

ErrorTrackerOptions

Re-exports ErrorTrackerOptions

EventManager

Re-exports EventManager

EventType

Re-exports EventType

EventTypeName

Re-exports EventTypeName

filterRequestsByPatterns

Re-exports filterRequestsByPatterns

FinalStatistics

Re-exports FinalStatistics

GetUserDataFromRequest

Re-exports GetUserDataFromRequest

GlobInput

Re-exports GlobInput

GlobObject

Re-exports GlobObject

GotScrapingHttpClient

Re-exports GotScrapingHttpClient

HttpRequest

Re-exports HttpRequest

HttpRequestOptions

Re-exports HttpRequestOptions

HttpResponse

Re-exports HttpResponse

IRequestList

Re-exports IRequestList

IStorage

Re-exports IStorage

KeyConsumer

Re-exports KeyConsumer

KeyValueStore

Re-exports KeyValueStore

KeyValueStoreIteratorOptions

Re-exports KeyValueStoreIteratorOptions

KeyValueStoreOptions

Re-exports KeyValueStoreOptions

LoadedRequest

Re-exports LoadedRequest

LocalEventManager

Re-exports LocalEventManager

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

NonRetryableError

Re-exports NonRetryableError

PERSIST_STATE_KEY

Re-exports PERSIST_STATE_KEY

PersistenceOptions

Re-exports PersistenceOptions

processHttpRequestOptions

Re-exports processHttpRequestOptions

ProxyConfiguration

Re-exports ProxyConfiguration

ProxyConfigurationFunction

Re-exports ProxyConfigurationFunction

ProxyConfigurationOptions

Re-exports ProxyConfigurationOptions

ProxyInfo

Re-exports ProxyInfo

PseudoUrl

Re-exports PseudoUrl

PseudoUrlInput

Re-exports PseudoUrlInput

PseudoUrlObject

Re-exports PseudoUrlObject

purgeDefaultStorages

Re-exports purgeDefaultStorages

PushErrorMessageOptions

Re-exports PushErrorMessageOptions

QueueOperationInfo

Re-exports QueueOperationInfo

RecordOptions

Re-exports RecordOptions

RedirectHandler

Re-exports RedirectHandler

RegExpInput

Re-exports RegExpInput

RegExpObject

Re-exports RegExpObject

Request

Re-exports Request

RequestHandler

Re-exports RequestHandler

RequestHandlerResult

Re-exports RequestHandlerResult

RequestList

Re-exports RequestList

RequestListOptions

Re-exports RequestListOptions

RequestListSourcesFunction

Re-exports RequestListSourcesFunction

RequestListState

Re-exports RequestListState

RequestOptions

Re-exports RequestOptions

RequestProvider

Re-exports RequestProvider

RequestProviderOptions

Re-exports RequestProviderOptions

RequestQueue

Re-exports RequestQueue

RequestQueueOperationOptions

Re-exports RequestQueueOperationOptions

RequestQueueOptions

Re-exports RequestQueueOptions

RequestQueueV1

Re-exports RequestQueueV1

RequestQueueV2

Re-exports RequestQueueV2

RequestState

Re-exports RequestState

RequestTransform

Re-exports RequestTransform

ResponseLike

Re-exports ResponseLike

ResponseTypes

Re-exports ResponseTypes

RestrictedCrawlingContext

Re-exports RestrictedCrawlingContext

RetryRequestError

Re-exports RetryRequestError

Router

Re-exports Router

RouterHandler

Re-exports RouterHandler

RouterRoutes

Re-exports RouterRoutes

Session

Re-exports Session

SessionError

Re-exports SessionError

SessionOptions

Re-exports SessionOptions

SessionPool

Re-exports SessionPool

SessionPoolOptions

Re-exports SessionPoolOptions

SessionState

Re-exports SessionState

SitemapRequestList

Re-exports SitemapRequestList

SitemapRequestListOptions

Re-exports SitemapRequestListOptions

SnapshotResult

Re-exports SnapshotResult

Snapshotter

Re-exports Snapshotter

SnapshotterOptions

Re-exports SnapshotterOptions

Source

Re-exports Source

StatisticPersistedState

Re-exports StatisticPersistedState

Statistics

Re-exports Statistics

StatisticsOptions

Re-exports StatisticsOptions

StatisticState

Re-exports StatisticState

StatusMessageCallback

Re-exports StatusMessageCallback

StatusMessageCallbackParams

Re-exports StatusMessageCallbackParams

StorageClient

Re-exports StorageClient

StorageManagerOptions

Re-exports StorageManagerOptions

StreamingHttpResponse

Re-exports StreamingHttpResponse

SystemInfo

Re-exports SystemInfo

SystemStatus

Re-exports SystemStatus

SystemStatusOptions

Re-exports SystemStatusOptions

TieredProxy

Re-exports TieredProxy

tryAbsoluteURL

Re-exports tryAbsoluteURL

UrlPatternObject

Re-exports UrlPatternObject

useState

Re-exports useState

UseStateOptions

Re-exports UseStateOptions

withCheckedStorageAccess

Re-exports withCheckedStorageAccess

FileDownloadErrorHandler

FileDownloadErrorHandler<UserData, JSONData>: ErrorHandler<FileDownloadCrawlingContext<UserData, JSONData>>

Type parameters

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

FileDownloadHook

FileDownloadHook<UserData, JSONData>: InternalHttpHook<FileDownloadCrawlingContext<UserData, JSONData>>

Type parameters

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

FileDownloadOptions

FileDownloadOptions<UserData, JSONData>: (Omit<HttpCrawlerOptions<FileDownloadCrawlingContext<UserData, JSONData>>, requestHandler> & { requestHandler?: never; streamHandler?: StreamHandler }) | (Omit<HttpCrawlerOptions<FileDownloadCrawlingContext<UserData, JSONData>>, requestHandler> & { requestHandler: FileDownloadRequestHandler; streamHandler?: never })

Type parameters

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

FileDownloadRequestHandler

FileDownloadRequestHandler<UserData, JSONData>: RequestHandler<FileDownloadCrawlingContext<UserData, JSONData>>

Type parameters

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

HttpErrorHandler

HttpErrorHandler<UserData, JSONData>: ErrorHandler<HttpCrawlingContext<UserData, JSONData>>

Type parameters

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

HttpHook

HttpHook<UserData, JSONData>: InternalHttpHook<HttpCrawlingContext<UserData, JSONData>>

Type parameters

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

HttpRequestHandler

HttpRequestHandler<UserData, JSONData>: RequestHandler<HttpCrawlingContext<UserData, JSONData>>

Type parameters

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

StreamHandlerContext

StreamHandlerContext: Omit<FileDownloadCrawlingContext, body | response | parseWithCheerio | json | addRequests | contentType> & { stream: Request }
Page Options