Skip to main content
Version: 2.3

Request

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 Apify SDK classes, such as RequestList, RequestQueue, PuppeteerCrawler or PlaywrightCrawler.

Example use:

const request = new Apify.Request({
    url: 'http://www.example.com',
    headers: { Accept: 'application/json' },
});

...

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

...

const foo = request.userData.foo;

Properties​

id​

Type: string

Request ID

url​

Type: string

URL of the web page to crawl.

loadedUrl​

Type: 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.

uniqueKey​

Type: string

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

method​

Type: string

HTTP method, e.g. GET or POST.

payload​

Type: string | Buffer

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

noRetry​

Type: boolean

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

retryCount​

Type: number

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

errorMessages​

Type: Array<string>

An array of error messages from request processing.

headers​

Type: Object<string, string>

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

userData​

Type: Object<string, *>

Custom user data assigned to the request.

handledAt​

Type: Date

Indicates the time when the request has been processed. Is null if the request has not been crawled yet.

new Request(options)​

Parameters:

  • options: RequestOptions - Request parameters including the URL, HTTP method and headers, and others.

request.headers​

request.userData​

request.pushErrorMessage(errorOrMessage, [options])​

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.

Parameters:

  • errorOrMessage: Error | string - Error object or error message to be stored in the request.
  • [options]: object
    • [omitStack]: boolean = false - Only push the error message without stack trace when true.