1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114# class: APIResponse
* since: v1.16
[APIResponse] class represents responses returned by [`method: APIRequestContext.get`] and similar methods.
```python async
import asyncio
from playwright.async_api import async_playwright, Playwright
async def run(playwright: Playwright):
context = await playwright.request.new_context()
response = await context.get("https://example.com/user/repos")
assert response.ok
assert response.status == 200
assert response.headers["content-type"] == "application/json; charset=utf-8"
json_data = await response.json()
assert json_data["name"] == "foobar"
assert await response.body() == '{"status": "ok"}'
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
```
```python sync
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"}'
```
## async method: APIResponse.body
* since: v1.16
- returns: <[Buffer]>
Returns the buffer with response body.
## async method: APIResponse.dispose
* since: v1.16
Disposes the body of this response. If not called then the body will stay in memory until the context closes.
## method: APIResponse.headers
* since: v1.16
- returns: <[Object]<[string], [string]>>
An object with all the response HTTP headers associated with this response.
## method: APIResponse.headersArray
* since: v1.16
- returns: <[Array]<[Object]>>
- `name` <[string]> Name of the header.
- `value` <[string]> Value of the header.
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.
## async method: APIResponse.json
* since: v1.16
* langs: js, python
- returns: <[Serializable]>
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse`.
## async method: APIResponse.json
* since: v1.16
* langs: csharp
- returns: <[null]|[JsonElement]>
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse`.
## method: APIResponse.ok
* since: v1.16
- returns: <[boolean]>
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
## method: APIResponse.status
* since: v1.16
- returns: <[int]>
Contains the status code of the response (e.g., 200 for a success).
## method: APIResponse.statusText
* since: v1.16
- returns: <[string]>
Contains the status text of the response (e.g. usually an "OK" for a success).
## async method: APIResponse.text
* since: v1.16
- returns: <[string]>
Returns the text representation of response body.
## method: APIResponse.url
* since: v1.16
- returns: <[string]>
Contains the URL of the response.