Interface APIRequest

newContext

• newContext(options?): Promise<APIRequestContext>

• Creates new instances of APIRequestContext.

  Parameters

  • Optional options: {
        baseURL?: string;
        extraHTTPHeaders?: {
            [key: string]: string;
        };
        httpCredentials?: {
            origin?: string;
            password: string;
            username: string;
        };
        ignoreHTTPSErrors?: boolean;
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        storageState?: string | {
            cookies: {
                domain: string;
                expires: number;
                httpOnly: boolean;
                name: string;
                path: string;
                sameSite: "Strict" | "Lax" | "None";
                secure: boolean;
                value: string;
            }[];
            origins: {
                localStorage: {
                    name: string;
                    value: string;
                }[];
                origin: string;
            }[];
        };
        timeout?: number;
        userAgent?: string;
    }

    Optional

    • Optional baseURL?: string

      Methods like apiRequestContext.get(url[, options]) 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

    • Optional extraHTTPHeaders?: {
          [key: string]: string;
      }

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

      • [key: string]: string

    • Optional httpCredentials?: {
          origin?: string;
          password: string;
          username: string;
      }

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

      • Optional origin?: string

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

      • password: string

      • username: string

    • Optional ignoreHTTPSErrors?: boolean

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

    • Optional proxy?: {
          bypass?: string;
          password?: string;
          server: string;
          username?: string;
      }

      Network proxy settings.

      • Optional bypass?: string

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

      • Optional password?: string

        Optional password to use if HTTP proxy requires authentication.

      • server: string

        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.

      • Optional username?: string

        Optional username to use if HTTP proxy requires authentication.

    • Optional storageState?: string | {
          cookies: {
              domain: string;
              expires: number;
              httpOnly: boolean;
              name: string;
              path: string;
              sameSite: "Strict" | "Lax" | "None";
              secure: boolean;
              value: string;
          }[];
          origins: {
              localStorage: {
                  name: string;
                  value: string;
              }[];
              origin: string;
          }[];
      }

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

    • Optional timeout?: number

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

    • Optional userAgent?: string

      Specific user agent to use in this context.

  Returns Promise<APIRequestContext>