class-request.mdx

id	class-request
title	Request

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import HTMLCard from '@site/src/components/HTMLCard';

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

• Page.onRequest(handler) emitted when the request is issued by the page.
• Page.onResponse(handler) emitted when/if the response status and headers are received for the request.
• Page.onRequestFinished(handler) emitted when the response body is downloaded and the request is complete.

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

:::note

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

allHeaders {#request-all-headers}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.allHeaders

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

Usage

Request.allHeaders();

Returns

• Map<String, String>#

---

existingResponse {#request-existing-response}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.59request.existingResponse

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.

Usage

Request.existingResponse();

Returns

• null | Response#

---

failure {#request-failure}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.failure

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

Usage

Example of logging of all the failed requests:

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

Returns

• null | String#

---

frame {#request-frame}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.frame

Returns the Frame that initiated this request.

Usage

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

Returns

• Frame#

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:

---

headerValue {#request-header-value}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.headerValue

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

Usage

Request.headerValue(name);

Arguments

• name String#

  Name of the header.

Returns

• null | String#

---

headers {#request-headers}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.headers

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.

Usage

Request.headers();

Returns

• Map<String, String>#

---

headersArray {#request-headers-array}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.headersArray

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.

Usage

Request.headersArray();

Returns

• List<HttpHeader>#

  • name String

    Name of the header.

  • value String

    Value of the header.

---

isNavigationRequest {#request-is-navigation-request}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.isNavigationRequest

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.

Usage

Request.isNavigationRequest();

Returns

• boolean#

---

method {#request-method}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.method

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

Usage

Request.method();

Returns

• String#

---

postData {#request-post-data}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.postData

Request's post body, if any.

Usage

Request.postData();

Returns

• null | String#

---

postDataBuffer {#request-post-data-buffer}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.postDataBuffer

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

Usage

Request.postDataBuffer();

Returns

• null | byte[]#

---

redirectedFrom {#request-redirected-from}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.redirectedFrom

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:

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:

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

Returns

• null | Request#

---

redirectedTo {#request-redirected-to}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.redirectedTo

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

Usage

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

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

Returns

• null | Request#

---

resourceType {#request-resource-type}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.resourceType

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, other.

Usage

Request.resourceType();

Returns

• String#

---

response {#request-response}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.response

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

Usage

Request.response();

Returns

• null | Response#

---

sizes {#request-sizes}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.15request.sizes

Returns resource size information for given request.

Usage

Request.sizes();

Returns

• Sizes#

  • requestBodySize int

    Size of the request body (POST data payload) in bytes. Set to 0 if there was no body.

  • requestHeadersSize int

    Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body.

  • responseBodySize int

    Size of the received response body (encoded) in bytes.

  • responseHeadersSize int

    Total number of bytes from the start of the HTTP response message until (and including) the double CRLF before the body.

---

timing {#request-timing}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.timing

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

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

Returns

• Timing#

  • startTime double

    Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC

  • domainLookupStart double

    Time immediately before the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • domainLookupEnd double

    Time immediately after the browser starts the domain name lookup for the resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • connectStart double

    Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • secureConnectionStart double

    Time immediately before the browser starts the handshake process to secure the current connection. The value is given in milliseconds relative to startTime, -1 if not available.

  • connectEnd double

    Time immediately before the user agent starts establishing the connection to the server to retrieve the resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • requestStart double

    Time immediately before the browser starts requesting the resource from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • responseStart double

    Time immediately after the browser receives the first byte of the response from the server, cache, or local resource. The value is given in milliseconds relative to startTime, -1 if not available.

  • responseEnd double

    Time immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first. The value is given in milliseconds relative to startTime, -1 if not available.

---

url {#request-url}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9request.url

URL of the request.

Usage

Request.url();

Returns

• String#