Skip to main content
Version: 3.1

Request <UserData>

Represents a URL to be crawled, optionally including HTTP method, headers, payload and other metadata. The Request object also stores information about errors that occurred during processing of the request.

Each Request instance has the uniqueKey property, which can be either specified manually in the constructor or generated automatically from the URL. Two requests with the same uniqueKey are considered as pointing to the same web resource. This behavior applies to all Crawlee classes, such as RequestList, RequestQueue, PuppeteerCrawler or PlaywrightCrawler.

Example use:

const request = new Request({
url: '',
headers: { Accept: 'application/json' },

... = 'bar';
request.pushErrorMessage(new Error('Request failed!'));


const foo =;




  • new Request<UserData>(options: RequestOptions<Dictionary<any>>): Request<UserData>
  • Request parameters including the URL, HTTP method and headers, and others.

    Type parameters

    • UserData: Dictionary<any> = Dictionary<any>


    • options: RequestOptions<Dictionary<any>>

    Returns Request<UserData>



errorMessages: string[]

An array of error messages from request processing.


handledAt?: string

ISO datetime string that indicates the time when the request has been processed. Is null if the request has not been crawled yet.


headers?: Record<string, string>

Object with HTTP headers. Key is header name, value is the value.


id?: string

Request ID


loadedUrl?: string

An actually loaded URL after redirects, if present. HTTP redirects are guaranteed to be included.

When using PuppeteerCrawler or PlaywrightCrawler, meta tag and JavaScript redirects may, or may not be included, depending on their nature. This generally means that redirects, which happen immediately will most likely be included, but delayed redirects will not.


method: AllowedHttpMethods

HTTP method, e.g. GET or POST.


noRetry: boolean

The true value indicates that the request will not be automatically retried on error.


payload?: string

HTTP request payload, e.g. for POST requests.


retryCount: number

Indicates the number of times the crawling of the request has been retried on error.


uniqueKey: string

A unique key identifying the request. Two requests with the same uniqueKey are considered as pointing to the same URL.


url: string

URL of the web page to crawl.


userData: UserData = ...

Custom user data assigned to the request.



  • get label(): undefined | string
  • set label(value: undefined | string): void
  • shortcut for getting request.userData.label

    Returns undefined | string

  • shortcut for setting request.userData.label


    • value: undefined | string

    Returns void


  • get skipNavigation(): boolean
  • set skipNavigation(value: boolean): void
  • Tells the crawler processing this request to skip the navigation and process the request directly.

    Returns boolean

  • Parameters

    • value: boolean

    Returns void



  • pushErrorMessage(errorOrMessage: unknown, options?: PushErrorMessageOptions): void
  • Stores information about an error that occurred during processing of this request.

    You should always use Error instances when throwing errors in JavaScript.

    Nevertheless, to improve the debugging experience when using third party libraries that may not always throw an Error instance, the function performs a type inspection of the passed argument and attempts to extract as much information as possible, since just throwing a bad type error makes any debugging rather difficult.


    • errorOrMessage: unknown

      Error object or error message to be stored in the request.

    • optionaloptions: PushErrorMessageOptions = {}

    Returns void