Skip to content

Request ​

Added in: v1.8

Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:

If request fails at some point, then instead of 'requestfinished' event (and possibly instead of 'response' event), the page.onRequestFailed() event is emitted.

INFO

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished' event.

If request gets a 'redirect' response, the request is successfully finished with the requestfinished event, and a new request is issued to a redirected url.

Methods ​

request.allHeaders() ​

Added in: v1.15

An object with all the request HTTP headers associated with this request. The header names are lower-cased.

Returns

  • Object<string, string>

request.existingResponse() ​

Added in: v1.59

Returns the Response object if the response has already been received, null otherwise.

Unlike request.response(), this method does not wait for the response to arrive. It returns immediately with the response object if the response has been received, or null if the response has not been received yet.

Returns

  • null | Response

request.failure() ​

Added in: v1.8

The method returns null unless this request has failed, as reported by requestfailed event.

Usage

Example of logging of all the failed requests:

java
page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});

Returns

  • null | string

request.frame() ​

Added in: v1.8

Returns the Frame that initiated this request.

Usage

java
String frameUrl = request.frame().url();

Details

Note that in some cases the frame is not available, and this method will throw.

  • When request originates in the Service Worker. You can use request.serviceWorker() to check that.
  • When navigation request is issued before the corresponding frame is created. You can use request.isNavigationRequest() to check that.

Here is an example that handles all the cases:

Returns

  • Frame

request.headers() ​

Added in: v1.8

An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return security-related headers, including cookie-related ones. You can use request.allHeaders() for complete list of headers that include cookie information.

Returns

  • Object<string, string>

request.headersArray() ​

Added in: v1.15

An array with all the request HTTP headers associated with this request. Unlike request.allHeaders(), header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Returns

  • Array<Object>

request.headerValue() ​

Added in: v1.15

Returns the value of the header matching the name. The name is case-insensitive.

Arguments

  • name string

    Name of the header.

Returns

  • null | string

request.isNavigationRequest() ​

Added in: v1.8

Whether this request is driving frame's navigation.

Some navigation requests are issued before the corresponding frame is created, and therefore do not have request.frame() available.

Returns

  • boolean

request.method() ​

Added in: v1.8

Request's method (GET, POST, etc.)

Returns

  • string

request.postData() ​

Added in: v1.8

Request's post body, if any.

Returns

  • null | string

request.postDataBuffer() ​

Added in: v1.8

Request's post body in a binary form, if any.

Returns

  • null | Buffer

request.redirectedFrom() ​

Added in: v1.8

Request that was redirected by the server to this one, if any.

When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by redirectedFrom() and redirectedTo() methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling redirectedFrom().

Usage

For example, if the website http://example.com redirects to https://example.com:

java
Response response = page.navigate("http://example.com");
System.out.println(response.request().redirectedFrom().url()); // "http://example.com"

If the website https://google.com has no redirects:

java
Response response = page.navigate("https://google.com");
System.out.println(response.request().redirectedFrom()); // null

Returns

  • null | Request

request.redirectedTo() ​

Added in: v1.8

New request issued by the browser if the server responded with redirect.

Usage

This method is the opposite of request.redirectedFrom():

java
System.out.println(request.redirectedFrom().redirectedTo() == request); // true

Returns

  • null | Request

request.resourceType() ​

Added in: v1.8

Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the following: document, stylesheet, image, media, font, script, texttrack, xhr, fetch, eventsource, websocket, manifest, beacon, ping, cspreport, other.

Returns

  • string

request.response() ​

Added in: v1.8

Returns the matching Response object, or null if the response was not received due to error.

Returns

  • null | Response

request.sizes() ​

Added in: v1.15

Returns resource size information for given request.

Returns

  • Object

request.timing() ​

Added in: v1.8

Returns resource timing information for given request. Most of the timing values become available upon the response, responseEnd becomes available when request finishes. Find more information at Resource Timing API.

Usage

java
page.onRequestFinished(request -> {
  Timing timing = request.timing();
  System.out.println(timing.responseEnd - timing.startTime);
});
page.navigate("http://example.com");

Returns

  • Object

request.url() ​

Added in: v1.8

URL of the request.

Returns

  • string

Released under the Apache 2.0 License.