Skip to main content
Version: 1.23

APIResponse

APIResponse class represents responses returned by api_request_context.get(url, **kwargs) and similar methods.

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"}'

api_response.body()

Returns the buffer with response body.

api_response.dispose()

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

api_response.headers

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

api_response.headers_array

  • returns: <List[Dict]>#
    • name <str> Name of the header.
    • value <str> Value of the header.

An array with all the request 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.

api_response.json()

Returns the JSON representation of response body.

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

api_response.ok

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

api_response.status

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

api_response.status_text

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

api_response.text()

Returns the text representation of response body.

api_response.url

Contains the URL of the response.