Skip to main content

Request

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

  • Page.Request emitted when the request is issued by the page.
  • Page.Response emitted when/if the response status and headers are received for the request.
  • Page.RequestFinished 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.RequestFailed 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​

AllHeadersAsync​

Added in: v1.15 request.AllHeadersAsync

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

Usage

await Request.AllHeadersAsync();

Returns

Failure​

Added in: v1.8 request.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.RequestFailed += (_, request) =>
{
    Console.WriteLine(request.Failure);
};

Returns

Frame​

Added in: v1.8 request.Frame

Returns the Frame that initiated this request.

Usage

var frameUrl = request.Frame.Url;

Returns

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:

HeaderValueAsync​

Added in: v1.15 request.HeaderValueAsync

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

Usage

await Request.HeaderValueAsync(name);

Arguments

Returns

Headers​

Added in: v1.8 request.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.AllHeadersAsync() for complete list of headers that include cookie information.

Usage

Request.Headers

Returns

HeadersArrayAsync​

Added in: v1.15 request.HeadersArrayAsync

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

Usage

await Request.HeadersArrayAsync();

Returns

IsNavigationRequest​

Added in: v1.8 request.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

Method​

Added in: v1.8 request.Method

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

Usage

Request.Method

Returns

PostData​

Added in: v1.8 request.PostData

Request's post body, if any.

Usage

Request.PostData

Returns

PostDataBuffer​

Added in: v1.8 request.PostDataBuffer

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

Usage

Request.PostDataBuffer

Returns

PostDataJSON​

Added in: v1.12 request.PostDataJSON

Returns parsed request's body for form-urlencoded and JSON as a fallback if any.

When the response is application/x-www-form-urlencoded then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.

Usage

Request.PostDataJSON

Returns

RedirectedFrom​

Added in: v1.8 request.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:

var response = await page.GotoAsync("http://www.microsoft.com");
Console.WriteLine(response.Request.RedirectedFrom?.Url); // http://www.microsoft.com

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

var response = await page.GotoAsync("https://www.google.com");
Console.WriteLine(response.Request.RedirectedFrom?.Url); // null

Returns

RedirectedTo​

Added in: v1.8 request.RedirectedTo

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

Usage

This method is the opposite of Request.RedirectedFrom:

Console.WriteLine(request.RedirectedFrom?.RedirectedTo == request); // True

Returns

ResourceType​

Added in: v1.8 request.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

ResponseAsync​

Added in: v1.8 request.ResponseAsync

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

Usage

await Request.ResponseAsync();

Returns

SizesAsync​

Added in: v1.15 request.SizesAsync

Returns resource size information for given request.

Usage

await Request.SizesAsync();

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​

Added in: v1.8 request.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

var request = await page.RunAndWaitForRequestFinishedAsync(async () =>
{
    await page.GotoAsync("https://www.microsoft.com");
});
Console.WriteLine(request.Timing.ResponseEnd);

Returns

  • Timing#

    • startTime [float]

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

    • domainLookupStart [float]

      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 [float]

      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 [float]

      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 [float]

      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 [float]

      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 [float]

      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 [float]

      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 [float]

      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​

Added in: v1.8 request.Url

URL of the request.

Usage

Request.Url

Returns