playwright/docs/src/api/class-apiresponse.md

# class: ApiResponse
* langs: js

[ApiResponse] class represents responses returned by [`method: APIRequestContext.get`] and similar methods.

## async method: ApiResponse.body
- returns: <[Buffer]>

Returns the buffer with response body.

## async method: ApiResponse.dispose

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

## method: ApiResponse.headers
- returns: <[Object]<[string], [string]>>

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

## method: ApiResponse.headersArray
- returns: <[Array]<[Object]>>
  - `name` <[string]> Name of the header.
  - `value` <[string]> 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.

## async method: ApiResponse.json
* 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
* 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
- returns: <[boolean]>

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

## method: ApiResponse.status
- returns: <[int]>

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

## method: ApiResponse.statusText
- returns: <[string]>

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

## async method: ApiResponse.text
- returns: <[string]>

Returns the text representation of response body.

## method: ApiResponse.url
- returns: <[string]>

Contains the URL of the response.