Network

Playwright provides APIs to monitor and modify network traffic, both HTTP and HTTPS. Any requests that page does, including XHRs and fetch requests, can be tracked, modified and handled.

• HTTP Authentication
• Network events
• Handle requests
• Modify requests
• Abort requests

HTTP Authentication

Sync

context = browser.new_context(

http_credentials={"username": "bill", "password": "pa55w0rd"}

)

page = context.new_page()

page.goto("https://example.com")

Async

context = await browser.new_context(

http_credentials={"username": "bill", "password": "pa55w0rd"}

)

page = await context.new_page()

await page.goto("https://example.com")

API reference

• browser.new_context(**kwargs)

Network events

You can monitor all the requests and responses:

Sync

from playwright.sync_api import sync_playwright

def run(playwright):

chromium = playwright.chromium

browser = chromium.launch()

page = browser.new_page()

# Subscribe to "request" and "response" events.

page.on("request", lambda request: print(">>", request.method, request.url))

page.on("response", lambda response: print("<<", response.status, response.url))

page.goto("https://example.com")

browser.close()

with sync_playwright() as playwright:

run(playwright)

Async

import asyncio

from playwright.async_api import async_playwright

async def run(playwright):

chromium = playwright.chromium

browser = await chromium.launch()

page = await browser.new_page()

# Subscribe to "request" and "response" events.

page.on("request", lambda request: print(">>", request.method, request.url))

page.on("response", lambda response: print("<<", response.status, response.url))

await page.goto("https://example.com")

await browser.close()

async def main():

async with async_playwright() as playwright:

await run(playwright)

asyncio.run(main())

Or wait for a network response after the button click:

Sync

# Use a glob url pattern

with page.expect_response("**/api/fetch_data") as response_info:

page.click("button#update")

response = response_info.value

Async

# Use a glob url pattern

async with page.expect_response("**/api/fetch_data") as response_info:

await page.click("button#update")

response = await response_info.value

Variations

Sync

# Use a regular expression

with page.expect_response(re.compile(r"\.jpeg$")) as response_info:

page.click("button#update")

response = response_info.value

# Use a predicate taking a response object

with page.expect_response(lambda response: token in response.url) as response_info:

page.click("button#update")

response = response_info.value

Async

# Use a regular expression

async with page.expect_response(re.compile(r"\.jpeg$")) as response_info:

await page.click("button#update")

response = await response_info.value

# Use a predicate taking a response object

async with page.expect_response(lambda response: token in response.url) as response_info:

await page.click("button#update")

response = await response_info.value

API reference

• Request
• Response
• page.on("request")
• page.on("response")
• page.expect_request(url_or_predicate, **kwargs)
• page.expect_response(url_or_predicate, **kwargs)

Handle requests

Sync

page.route(

"**/api/fetch_data",

lambda route: route.fulfill(status=200, body=test_data))

page.goto("https://example.com")

Async

await page.route(

"**/api/fetch_data",

lambda route: route.fulfill(status=200, body=test_data))

await page.goto("https://example.com")

You can mock API endpoints via handling the network quests in your Playwright script.

Variations

Sync

# Set up route on the entire browser context.

# It will apply to popup windows and opened links.

context.route(

"**/api/login",

lambda route: route.fulfill(status=200, body="accept"))

page.goto("https://example.com")

Async

# Set up route on the entire browser context.

# It will apply to popup windows and opened links.

await context.route(

"**/api/login",

lambda route: route.fulfill(status=200, body="accept"))

await page.goto("https://example.com")

API reference

• browser_context.route(url, handler)
• browser_context.unroute(url, **kwargs)
• page.route(url, handler)
• page.unroute(url, **kwargs)
• Route

Modify requests

Sync

# Delete header

def handle_route(route):

headers = route.request.headers

del headers["x-secret"]

route.continue_(headers=headers)

page.route("**/*", handle_route)

# Continue requests as POST.

page.route("**/*", lambda route: route.continue_(method="POST"))

Async

# Delete header

async def handle_route(route):

headers = route.request.headers

del headers["x-secret"]

route.continue_(headers=headers)

await page.route("**/*", handle_route)

# Continue requests as POST.

await page.route("**/*", lambda route: route.continue_(method="POST"))

You can continue requests with modifications. Example above removes an HTTP header from the outgoing requests.

Abort requests

Sync

page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())

# Abort based on the request type

page.route("**/*", lambda route: route.abort() if route.request.resource_type == "image" else route.continue_())

Async

await page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())

# Abort based on the request type

await page.route("**/*", lambda route: route.abort() if route.request.resource_type == "image" else route.continue_())

API reference

• page.route(url, handler)
• browser_context.route(url, handler)
• route.abort(**kwargs)