APIResponse

APIResponse class represents responses returned by api_request_context.get() and similar methods.

• Sync
• Async

from playwright.sync_api import sync_playwright

with sync_playwright() as p:
    context = playwright.request.new_context()
    response = context.get("https://example.com/user/repos")
    assert response.ok
    assert response.status == 200
    assert response.headers["content-type"] == "application/json; charset=utf-8"
    assert response.json()["name"] == "foobar"
    assert response.body() == '{"status": "ok"}'

---

Methods

body

Added in: v1.16 apiResponse.body

Returns the buffer with response body.

Usage

api_response.body()

Returns

• bytes#

---

dispose

Added in: v1.16 apiResponse.dispose

Disposes the body of this response. If not called then the body will stay in memory until the context closes.

Usage

api_response.dispose()

Returns

• NoneType#

---

json

Added in: v1.16 apiResponse.json

Returns the JSON representation of response body.

This method will throw if the response body is not parsable via JSON.parse.

Usage

api_response.json()

Returns

• Dict#

---

security_details

Added in: v1.61 apiResponse.security_details

Returns SSL and other security information. Resolves to null for non-HTTPS responses. For redirected requests, returns the information for the last request in the redirect chain.

Usage

api_response.security_details()

Returns

• NoneType | Dict#

  • issuer str (optional)

    Common Name component of the Issuer field. from the certificate. This should only be used for informational purposes. Optional.

  • protocol str (optional)

    The specific TLS protocol used. (e.g. TLS 1.3). Optional.

  • subjectName str (optional)

    Common Name component of the Subject field from the certificate. This should only be used for informational purposes. Optional.

  • validFrom float (optional)

    Unix timestamp (in seconds) specifying when this cert becomes valid. Optional.

  • validTo float (optional)

    Unix timestamp (in seconds) specifying when this cert becomes invalid. Optional.

---

server_addr

Added in: v1.61 apiResponse.server_addr

Returns the IP address and port of the server. Resolves to null if the server address is not available. For redirected requests, returns the information for the last request in the redirect chain.

Usage

api_response.server_addr()

Returns

• NoneType | Dict#

  • ipAddress str

    IPv4 or IPV6 address of the server.

  • port int

---

text

Added in: v1.16 apiResponse.text

Returns the text representation of response body.

Usage

api_response.text()

Returns

• str#

---

Properties

headers

Added in: v1.16 apiResponse.headers

An object with all the response HTTP headers associated with this response.

Usage

api_response.headers

Returns

• Dict[str, str]#

---

headers_array

Added in: v1.16 apiResponse.headers_array

An array with all the response HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Usage

api_response.headers_array

Returns

• List[Dict]#

  • name str

    Name of the header.

  • value str

    Value of the header.

---

ok

Added in: v1.16 apiResponse.ok

Contains a boolean stating whether the response was successful (status in the range 200-299) or not.

Usage

api_response.ok

Returns

• bool#

---

status

Added in: v1.16 apiResponse.status

Contains the status code of the response (e.g., 200 for a success).

Usage

api_response.status

Returns

• int#

---

status_text

Added in: v1.16 apiResponse.status_text

Contains the status text of the response (e.g. usually an "OK" for a success).

Usage

api_response.status_text

Returns

• str#

---

timing

Added in: v1.62 apiResponse.timing

Returns resource timing information for given response. For redirected requests, returns the information for the last request in the redirect chain. When the response is served from the HAR file, timing information is not available and all the values are -1. Find more information at Resource Timing API.

Usage

api_response.timing

Returns

• Dict#

  • startTime float

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

  • domainLookupStart float

    Time immediately before the client 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 client ends 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 client 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 client 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 after the client establishes 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 client 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 client 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 client 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.16 apiResponse.url

Contains the URL of the response.

Usage

api_response.url

Returns

• str#