APIRequest

Exposes API that can be used for the Web API testing. This class is used for creating APIRequestContext instance which in turn can be used for sending web requests. An instance of this class can be obtained via playwright.request. For more information see APIRequestContext.

---

Methods

new_context

Added in: v1.16 apiRequest.new_context

Creates new instances of APIRequestContext.

Usage

api_request.new_context()
api_request.new_context(**kwargs)

Arguments

• base_url str (optional)#

  Methods like api_request_context.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL. Examples:

  • baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
  • baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
  • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

• extra_http_headers Dict[str, str] (optional)#

  An object containing additional HTTP headers to be sent with every request. Defaults to none.

• http_credentials Dict (optional)#

  • username str

  • password str

  • origin str (optional)

    Restrain sending http credentials on specific origin (scheme://host:port).

  Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

• ignore_https_errors bool (optional)#

  Whether to ignore HTTPS errors when sending network requests. Defaults to false.

• proxy Dict (optional)#

  • server str

    Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.

  • bypass str (optional)

    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

  • username str (optional)

    Optional username to use if HTTP proxy requires authentication.

  • password str (optional)

    Optional password to use if HTTP proxy requires authentication.

  Network proxy settings.

• storage_state Union[str, pathlib.Path]|Dict (optional)#

  • cookies List[Dict]

    • name str

    • value str

    • domain str

    • path str

    • expires float

      Unix time in seconds.

    • httpOnly bool

    • secure bool

    • sameSite "Strict"|"Lax"|"None"

  • origins List[Dict]

    • origin str

    • localStorage List[Dict]

      • name str

      • value str

  Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browser_context.storage_state() or api_request_context.storage_state(). Either a path to the file with saved storage, or the value returned by one of browser_context.storage_state() or api_request_context.storage_state() methods.

• timeout float (optional)#

  Maximum time in milliseconds to wait for the response. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

• user_agent str (optional)#

  Specific user agent to use in this context.

Returns

• APIRequestContext#