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 or PuppeteerCrawler.

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

Param	Type
id	String
Request ID
url	String
URL of the web page to crawl.
uniqueKey	String
A unique key identifying the request. Two requests with the same uniqueKey are considered as pointing to the same URL.
method	String
HTTP method, e.g. GET or POST.
payload	String
HTTP request payload, e.g. for POST requests.
retry	Boolean
Indicates whether the request will be automatically retried or not.
retryCount	Number
Indicates the number of times the crawling of the request has been retried on error.
errorMessages	Array<String>
An array of error messages from request processing.
headers	Object
Object with HTTP headers. Key is header name, value is the value.
userData	Object
Custom user data assigned to the request.
handledAt	Date
Indicates the time when the request has been processed. Is null if the request has not been crawled yet.

• Request
  • new Request(options)
  • .pushErrorMessage(errorOrMessage, [options])
  • .doNotRetry([message])

new Request(options)

Param	Type	Default
options	object
All Request parameters are passed via an options object with the following keys:
options.url	String
URL of the web page to crawl. It must be a non-empty string.
[options.uniqueKey]	String
A unique key identifying the request. Two requests with the same uniqueKey are considered as pointing to the same URL. If uniqueKey is not provided, then it is automatically generated by normalizing the URL. For example, the URL of HTTP://www.EXAMPLE.com/something/ will produce the uniqueKey of http://www.example.com/something. The keepUrlFragment option determines whether URL hash fragment is included in the uniqueKey or not. Beware that the HTTP method and payload are not included in the uniqueKey, so requests to the same URL but with different HTTP methods or different POST payloads are all considered equal and will be deduplicated by RequestList and RequestQueue. Pass an arbitrary non-empty text value to the uniqueKey property to override the default behavior and specify which URLs shall be considered equal.
[options.method]	String	'GET'
[options.payload]	String | Buffer
HTTP request payload, e.g. for POST requests.
[options.headers]	Object	{}
HTTP headers in the following format: { Accept: 'text/html', 'Content-Type': 'application/json' }
[options.userData]	Object	{}
Custom user data assigned to the request. Use this to save any request related data to the request's scope, keeping them accessible on retries, failures etc.
[options.keepUrlFragment]	Boolean	false
If false then the hash part of a URL is removed when computing the uniqueKey property. For example, this causes the http://www.example.com#foo and http://www.example.com#bar URLs to have the same uniqueKey of http://www.example.com and thus the URLs are considered equal. Note that this option only has an effect if uniqueKey is not set.

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.

Param	Type	Default
errorOrMessage	Error | String
Error object or error message to be stored in the request.
[options]	Object
[options.omitStack]	Boolean	false
Only push the error message without stack trace when true.

request.doNotRetry([message])

Flags the request with no retry which prevents BasicCrawler (and {@PuppeteerCrawler} + {@CheerioCrawler}, since they use {@BasicCrawler} internally) from retrying the request after an error occurs.

Optionally accepts a message that will be used to construct and throw an Error.

Param	Type
[message]	String