# Scrapfly Documentation ## Table of Contents ### Dashboard - [Intro](https://scrapfly.io/docs) - [Project](https://scrapfly.io/docs/project) - [Account](https://scrapfly.io/docs/account) - [Workspace & Team](https://scrapfly.io/docs/workspace-and-team) - [Billing](https://scrapfly.io/docs/billing) ### Products #### MCP Server - [Getting Started](https://scrapfly.io/docs/mcp/getting-started) - [Tools & API Spec](https://scrapfly.io/docs/mcp/tools) - [Authentication](https://scrapfly.io/docs/mcp/authentication) - [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples) - [FAQ](https://scrapfly.io/docs/mcp/faq) ##### Integrations - [Overview](https://scrapfly.io/docs/mcp/integrations) - [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop) - [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code) - [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt) - [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor) - [Cline](https://scrapfly.io/docs/mcp/integrations/cline) - [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf) - [Zed](https://scrapfly.io/docs/mcp/integrations/zed) - [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code) - [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode) - [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain) - [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex) - [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai) - [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai) - [n8n](https://scrapfly.io/docs/mcp/integrations/n8n) - [Make](https://scrapfly.io/docs/mcp/integrations/make) - [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier) - [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi) - [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder) - [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client) #### Web Scraping API - [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started) - [API Specification]() - [Monitoring](https://scrapfly.io/docs/monitoring) - [Customize Request](https://scrapfly.io/docs/scrape-api/custom) - [Debug](https://scrapfly.io/docs/scrape-api/debug) - [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection) - [Proxy](https://scrapfly.io/docs/scrape-api/proxy) - [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode) - [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog) - [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify) - [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction) - [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering) - [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario) - [SSL](https://scrapfly.io/docs/scrape-api/ssl) - [DNS](https://scrapfly.io/docs/scrape-api/dns) - [Cache](https://scrapfly.io/docs/scrape-api/cache) - [Session](https://scrapfly.io/docs/scrape-api/session) - [Webhook](https://scrapfly.io/docs/scrape-api/webhook) - [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot) - [Errors](https://scrapfly.io/docs/scrape-api/errors) - [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout) - [Throttling](https://scrapfly.io/docs/throttling) - [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot) - [Billing](https://scrapfly.io/docs/scrape-api/billing) - [FAQ](https://scrapfly.io/docs/scrape-api/faq) #### Crawler API - [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started) - [API Specification]() - [Retrieving Results](https://scrapfly.io/docs/crawler-api/results) - [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format) - [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules) - [Webhook](https://scrapfly.io/docs/crawler-api/webhook) - [Billing](https://scrapfly.io/docs/crawler-api/billing) - [Errors](https://scrapfly.io/docs/crawler-api/errors) - [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot) - [FAQ](https://scrapfly.io/docs/crawler-api/faq) #### Screenshot API - [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started) - [API Specification]() - [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility) - [Webhook](https://scrapfly.io/docs/screenshot-api/webhook) - [Billing](https://scrapfly.io/docs/screenshot-api/billing) - [Errors](https://scrapfly.io/docs/screenshot-api/errors) #### Extraction API - [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started) - [API Specification]() - [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template) - [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt) - [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai) - [Webhook](https://scrapfly.io/docs/extraction-api/webhook) - [Billing](https://scrapfly.io/docs/extraction-api/billing) - [Errors](https://scrapfly.io/docs/extraction-api/errors) - [FAQ](https://scrapfly.io/docs/extraction-api/faq) #### Proxy Saver - [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started) - [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints) - [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations) - [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates) - [Protocols](https://scrapfly.io/docs/proxy-saver/protocols) - [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile) - [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security) - [Billing](https://scrapfly.io/docs/proxy-saver/billing) #### Cloud Browser API - [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started) - [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy) - [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock) - [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads) - [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume) - [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop) - [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode) - [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy) - [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions) - [Native Browser MCP](https://scrapfly.io/docs/cloud-browser-api/mcp) - [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference) ##### Integrations - [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer) - [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright) - [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium) - [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser) - [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use) - [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand) - [Billing](https://scrapfly.io/docs/cloud-browser-api/billing) - [Errors](https://scrapfly.io/docs/cloud-browser-api/errors) ### Tools - [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector) ### SDK - [Golang](https://scrapfly.io/docs/sdk/golang) - [Python](https://scrapfly.io/docs/sdk/python) - [Rust](https://scrapfly.io/docs/sdk/rust) - [TypeScript](https://scrapfly.io/docs/sdk/typescript) - [Scrapy](https://scrapfly.io/docs/sdk/scrapy) ### Integrations - [Getting Started](https://scrapfly.io/docs/integration/getting-started) - [LangChain](https://scrapfly.io/docs/integration/langchain) - [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex) - [CrewAI](https://scrapfly.io/docs/integration/crewai) - [Zapier](https://scrapfly.io/docs/integration/zapier) - [Make](https://scrapfly.io/docs/integration/make) - [n8n](https://scrapfly.io/docs/integration/n8n) ### Academy - [Overview](https://scrapfly.io/academy) - [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview) - [Tools](https://scrapfly.io/academy/tools-overview) - [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering) - [Static Scraping](https://scrapfly.io/academy/static-scraping) - [HTML Parsing](https://scrapfly.io/academy/html-parsing) - [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping) - [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping) - [Headless Browsers](https://scrapfly.io/academy/headless-browsers) - [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data) - [JSON Parsing](https://scrapfly.io/academy/json-parsing) - [Data Processing](https://scrapfly.io/academy/data-processing) - [Scaling](https://scrapfly.io/academy/scaling) - [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary) - [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking) - [Proxies](https://scrapfly.io/academy/proxies) --- 1. [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference) 2. Page # Page Actions and events related to the inspected page belong to the page domain. **Dependencies:** [Debugger](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Debugger), [DOM](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/DOM), [IO](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/IO), [Network](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Network), [Runtime](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Runtime) - [Commands (64)](#commands) - [Events (28)](#events) - [Types (62)](#types) No symbols match your filter. ## Commands #### `Page.addScriptToEvaluateOnLoad` Experimental Deprecated Deprecated, please use addScriptToEvaluateOnNewDocument instead. ###### Parameters | Name | Type | Description | |---|---|---| | `scriptSource` | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `identifier` | `ScriptIdentifier` | Identifier of the added script. | #### `Page.addScriptToEvaluateOnNewDocument` Evaluates given script in every frame upon creation (before loading frame's scripts). ###### Parameters | Name | Type | Description | |---|---|---| | `source` | `string` | | | `worldName` (optional) Experimental | `string` | If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted. | | `includeCommandLineAPI` (optional) Experimental | `boolean` | Specifies whether command line API should be available to the script, defaults to false. | | `runImmediately` (optional) Experimental | `boolean` | If true, runs the script immediately on existing execution contexts or worlds. Default: false. | ###### Return Object | Name | Type | Description | |---|---|---| | `identifier` | `ScriptIdentifier` | Identifier of the added script. | #### `Page.bringToFront` Brings page to front (activates tab). #### `Page.captureScreenshot` Capture page screenshot. ###### Parameters | Name | Type | Description | |---|---|---| | `format` (optional) | `string` | Image compression format (defaults to png). | | `quality` (optional) | `integer` | Compression quality from range \[0..100\] (jpeg only). | | `clip` (optional) | `Viewport` | Capture the screenshot of a given region only. | | `fromSurface` (optional) Experimental | `boolean` | Capture the screenshot from the surface, rather than the view. Defaults to true. | | `captureBeyondViewport` (optional) Experimental | `boolean` | Capture the screenshot beyond the viewport. Defaults to false. | | `optimizeForSpeed` (optional) Experimental | `boolean` | Optimize image encoding for speed, not for resulting size (defaults to false) | ###### Return Object | Name | Type | Description | |---|---|---| | `data` | `binary` | Base64-encoded image data. | #### `Page.captureSnapshot` Experimental Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles. ###### Parameters | Name | Type | Description | |---|---|---| | `format` (optional) | `string` | Format (defaults to mhtml). | ###### Return Object | Name | Type | Description | |---|---|---| | `data` | `string` | Serialized page data. | #### `Page.clearDeviceMetricsOverride` Experimental Deprecated Clears the overridden device metrics. Redirects to: Emulation #### `Page.clearDeviceOrientationOverride` Experimental Deprecated Clears the overridden Device Orientation. Redirects to: DeviceOrientation #### `Page.clearGeolocationOverride` Deprecated Clears the overridden Geolocation Position and Error. Redirects to: Emulation #### `Page.createIsolatedWorld` Creates an isolated world for the given frame. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame in which the isolated world should be created. | | `worldName` (optional) | `string` | An optional name which is reported in the Execution Context. | | `grantUniveralAccess` (optional) | `boolean` | Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution. | ###### Return Object | Name | Type | Description | |---|---|---| | `executionContextId` | `Runtime.ExecutionContextId` | Execution context of the isolated world. | #### `Page.deleteCookie` Experimental Deprecated Deletes browser cookie with given name, domain and path. Redirects to: Network ###### Parameters | Name | Type | Description | |---|---|---| | `cookieName` | `string` | Name of the cookie to remove. | | `url` | `string` | URL to match cooke domain and path. | #### `Page.disable` Disables page domain notifications. #### `Page.enable` Enables page domain notifications. ###### Parameters | Name | Type | Description | |---|---|---| | `enableFileChooserOpenedEvent` (optional) Experimental | `boolean` | If true, the `Page.fileChooserOpened` event will be emitted regardless of the state set by `Page.setInterceptFileChooserDialog` command (default: false). | #### `Page.getAppManifest` Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately. ###### Parameters | Name | Type | Description | |---|---|---| | `manifestId` (optional) | `string` | | ###### Return Object | Name | Type | Description | |---|---|---| | `url` | `string` | Manifest location. | | `errors` | `array<AppManifestError>` | | | `data` (optional) | `string` | Manifest content. | | `parsed` (optional) Experimental Deprecated | `AppManifestParsedProperties` | Parsed manifest properties. Deprecated, use manifest instead. | | `manifest` Experimental | `WebAppManifest` | | #### `Page.getInstallabilityErrors` Experimental ###### Return Object | Name | Type | Description | |---|---|---| | `installabilityErrors` | `array<InstallabilityError>` | | #### `Page.getManifestIcons` Experimental Deprecated Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation. ###### Return Object | Name | Type | Description | |---|---|---| | `primaryIcon` (optional) | `binary` | | #### `Page.getAppId` Experimental Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled ###### Return Object | Name | Type | Description | |---|---|---| | `appId` (optional) | `string` | App id, either from manifest's id attribute or computed from start\_url | | `recommendedId` (optional) | `string` | Recommendation for manifest's id attribute to match current id computed from start\_url | #### `Page.getAdScriptAncestry` Experimental ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | | ###### Return Object | Name | Type | Description | |---|---|---| | `adScriptAncestry` (optional) | `AdScriptAncestry` | The ancestry chain of ad script identifiers leading to this frame's creation, along with the root script's filterlist rule. The ancestry chain is ordered from the most immediate script (in the frame creation stack) to more distant ancestors (that created the immediately preceding script). Only sent if frame is labelled as an ad and ids are available. | #### `Page.getFrameTree` Returns present frame tree structure. ###### Return Object | Name | Type | Description | |---|---|---| | `frameTree` | `FrameTree` | Present frame tree structure. | #### `Page.getRenderedContent` Experimental Scrapfly Returns the full rendered content of the page. For text-serializable types (HTML, XML, JSON, etc.), returns rendered HTML with iframe content inlined. For binary types (PDF, images, etc.), returns the raw body bytes as base64. ###### Parameters | Name | Type | Description | |---|---|---| | `renderIframe` (optional) | `boolean` | When false, skip rendering iframe content (faster). Default true. | ###### Return Object | Name | Type | Description | |---|---|---| | `content` | `string` | The page content. For text types this is rendered HTML with iframes inlined. For binary types this is base64-encoded raw body bytes. | | `type` | `string` | "text" for text-serializable content, "binary" for non-text (base64-encoded). | #### `Page.getNavigationResponse` Experimental Scrapfly Returns the navigation response chain for the current page, including all redirect hops and the final response with status codes and headers. ###### Return Object | Name | Type | Description | |---|---|---| | `entries` | `array<NavigationResponseEntry>` | Array of navigation response entries (redirects + final response). | #### `Page.fetch` Experimental Makes an HTTP request from the browser process using the page's cookie jar and network context. Follows redirects by default and returns the full redirect chain alongside the final response. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | URL to fetch. | | `method` (optional) | `string` | HTTP method (GET, POST, etc.). Default: GET. | | `headers` (optional) | `object` | Request headers as key-value pairs. | | `body` (optional) | `string` | Request body for POST/PUT requests. | | `followRedirects` (optional) | `boolean` | Whether to follow redirects. Default: true. | ###### Return Object | Name | Type | Description | |---|---|---| | `content` | `string` | The final response content (text or base64-encoded binary). | | `encoding` | `string` | Content encoding: "text" or "base64". | | `statusCode` | `integer` | HTTP status code of the final response. | | `responseHeaders` | `object` | Response headers of the final response. | | `mimeType` | `string` | MIME type of the response. | | `url` | `string` | The final URL after redirects. | | `redirectChain` (optional) | `array<FetchRedirectEntry>` | Array of redirect entries (each hop in the redirect chain). | #### `Page.getLayoutMetrics` Returns metrics relating to the layouting of the page, such as viewport bounds/scale. ###### Return Object | Name | Type | Description | |---|---|---| | `layoutViewport` Deprecated | `LayoutViewport` | Deprecated metrics relating to the layout viewport. Is in device pixels. Use `cssLayoutViewport` instead. | | `visualViewport` Deprecated | `VisualViewport` | Deprecated metrics relating to the visual viewport. Is in device pixels. Use `cssVisualViewport` instead. | | `contentSize` Deprecated | `DOM.Rect` | Deprecated size of scrollable area. Is in DP. Use `cssContentSize` instead. | | `cssLayoutViewport` | `LayoutViewport` | Metrics relating to the layout viewport in CSS pixels. | | `cssVisualViewport` | `VisualViewport` | Metrics relating to the visual viewport in CSS pixels. | | `cssContentSize` | `DOM.Rect` | Size of scrollable area in CSS pixels. | #### `Page.getNavigationHistory` Returns navigation history for the current page. ###### Return Object | Name | Type | Description | |---|---|---| | `currentIndex` | `integer` | Index of the current navigation history entry. | | `entries` | `array<NavigationEntry>` | Array of navigation history entries. | #### `Page.resetNavigationHistory` Resets navigation history for the current page. #### `Page.getResourceContent` Experimental Returns content of the given resource. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Frame id to get resource for. | | `url` | `string` | URL of the resource to get content for. | ###### Return Object | Name | Type | Description | |---|---|---| | `content` | `string` | Resource content. | | `base64Encoded` | `boolean` | True, if content was served as base64. | #### `Page.getResourceTree` Experimental Returns present frame / resource tree structure. ###### Return Object | Name | Type | Description | |---|---|---| | `frameTree` | `FrameResourceTree` | Present frame / resource tree structure. | #### `Page.handleJavaScriptDialog` Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload). ###### Parameters | Name | Type | Description | |---|---|---| | `accept` | `boolean` | Whether to accept or dismiss the dialog. | | `promptText` (optional) | `string` | The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog. | #### `Page.navigate` Navigates current page to the given URL. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | URL to navigate the page to. | | `referrer` (optional) | `string` | Referrer URL. | | `transitionType` (optional) | `TransitionType` | Intended transition type. | | `frameId` (optional) | `FrameId` | Frame id to navigate, if not specified navigates the top frame. | | `referrerPolicy` (optional) Experimental | `ReferrerPolicy` | Referrer-policy used for the navigation. | ###### Return Object | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Frame id that has navigated (or failed to navigate) | | `loaderId` (optional) | `Network.LoaderId` | Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change. | | `errorText` (optional) | `string` | User friendly error message, present if and only if navigation has failed. | | `isDownload` (optional) Experimental | `boolean` | Whether the navigation resulted in a download. | #### `Page.navigateToHistoryEntry` Navigates current page to the given history entry. ###### Parameters | Name | Type | Description | |---|---|---| | `entryId` | `integer` | Unique id of the entry to navigate to. | #### `Page.printToPDF` Print page as PDF. ###### Parameters | Name | Type | Description | |---|---|---| | `landscape` (optional) | `boolean` | Paper orientation. Defaults to false. | | `displayHeaderFooter` (optional) | `boolean` | Display header and footer. Defaults to false. | | `printBackground` (optional) | `boolean` | Print background graphics. Defaults to false. | | `scale` (optional) | `number` | Scale of the webpage rendering. Defaults to 1. | | `paperWidth` (optional) | `number` | Paper width in inches. Defaults to 8.5 inches. | | `paperHeight` (optional) | `number` | Paper height in inches. Defaults to 11 inches. | | `marginTop` (optional) | `number` | Top margin in inches. Defaults to 1cm (~0.4 inches). | | `marginBottom` (optional) | `number` | Bottom margin in inches. Defaults to 1cm (~0.4 inches). | | `marginLeft` (optional) | `number` | Left margin in inches. Defaults to 1cm (~0.4 inches). | | `marginRight` (optional) | `number` | Right margin in inches. Defaults to 1cm (~0.4 inches). | | `pageRanges` (optional) | `string` | Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end. | | `headerTemplate` (optional) | `string` | HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - `date`: formatted print date - `title`: document title - `url`: document location - `pageNumber`: current page number - `totalPages`: total pages in the document For example, `<span class=title></span>` would generate span containing the title. | | `footerTemplate` (optional) | `string` | HTML template for the print footer. Should use the same format as the `headerTemplate`. | | `preferCSSPageSize` (optional) | `boolean` | Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size. | | `transferMode` (optional) Experimental | `string` | return as stream | | `generateTaggedPDF` (optional) Experimental | `boolean` | Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice. | | `generateDocumentOutline` (optional) Experimental | `boolean` | Whether or not to embed the document outline into the PDF. | ###### Return Object | Name | Type | Description | |---|---|---| | `data` | `binary` | Base64-encoded pdf data. Empty if \|returnAsStream\| is specified. | | `stream` (optional) Experimental | `IO.StreamHandle` | A handle of the stream that holds resulting PDF data. | #### `Page.reload` Reloads given page optionally ignoring the cache. ###### Parameters | Name | Type | Description | |---|---|---| | `ignoreCache` (optional) | `boolean` | If true, browser cache is ignored (as if the user pressed Shift+refresh). | | `scriptToEvaluateOnLoad` (optional) | `string` | If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin. | | `loaderId` (optional) Experimental | `Network.LoaderId` | If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation. | #### `Page.removeScriptToEvaluateOnLoad` Experimental Deprecated Deprecated, please use removeScriptToEvaluateOnNewDocument instead. ###### Parameters | Name | Type | Description | |---|---|---| | `identifier` | `ScriptIdentifier` | | #### `Page.removeScriptToEvaluateOnNewDocument` Removes given script from the list. ###### Parameters | Name | Type | Description | |---|---|---| | `identifier` | `ScriptIdentifier` | | #### `Page.screencastFrameAck` Experimental Acknowledges that a screencast frame has been received by the frontend. ###### Parameters | Name | Type | Description | |---|---|---| | `sessionId` | `integer` | Frame number. | #### `Page.searchInResource` Experimental Searches for given string in resource content. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Frame id for resource to search in. | | `url` | `string` | URL of the resource to search in. | | `query` | `string` | String to search for. | | `caseSensitive` (optional) | `boolean` | If true, search is case sensitive. | | `isRegex` (optional) | `boolean` | If true, treats string parameter as regex. | ###### Return Object | Name | Type | Description | |---|---|---| | `result` | `array<Debugger.SearchMatch>` | List of search matches. | #### `Page.setAdBlockingEnabled` Experimental Enable Chrome's experimental ad filter on all sites. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether to block ads. | #### `Page.setBypassCSP` Enable page Content Security Policy by-passing. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether to bypass page CSP. | #### `Page.getPermissionsPolicyState` Experimental Get Permissions Policy state on given frame. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | | ###### Return Object | Name | Type | Description | |---|---|---| | `states` | `array<PermissionsPolicyFeatureState>` | | #### `Page.getOriginTrials` Experimental Get Origin Trials on given frame. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | | ###### Return Object | Name | Type | Description | |---|---|---| | `originTrials` | `array<OriginTrial>` | | #### `Page.setDeviceMetricsOverride` Experimental Deprecated Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results). Redirects to: Emulation ###### Parameters | Name | Type | Description | |---|---|---| | `width` | `integer` | Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override. | | `height` | `integer` | Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override. | | `deviceScaleFactor` | `number` | Overriding device scale factor value. 0 disables the override. | | `mobile` | `boolean` | Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more. | | `scale` (optional) | `number` | Scale to apply to resulting view image. | | `screenWidth` (optional) | `integer` | Overriding screen width value in pixels (minimum 0, maximum 10000000). | | `screenHeight` (optional) | `integer` | Overriding screen height value in pixels (minimum 0, maximum 10000000). | | `positionX` (optional) | `integer` | Overriding view X position on screen in pixels (minimum 0, maximum 10000000). | | `positionY` (optional) | `integer` | Overriding view Y position on screen in pixels (minimum 0, maximum 10000000). | | `dontSetVisibleSize` (optional) | `boolean` | Do not set visible view size, rely upon explicit setVisibleSize call. | | `screenOrientation` (optional) | `Emulation.ScreenOrientation` | Screen orientation override. | | `viewport` (optional) | `Viewport` | The viewport dimensions and scale. If not set, the override is cleared. | #### `Page.setDeviceOrientationOverride` Experimental Deprecated Overrides the Device Orientation. Redirects to: DeviceOrientation ###### Parameters | Name | Type | Description | |---|---|---| | `alpha` | `number` | Mock alpha | | `beta` | `number` | Mock beta | | `gamma` | `number` | Mock gamma | #### `Page.setFontFamilies` Experimental Set generic font families. ###### Parameters | Name | Type | Description | |---|---|---| | `fontFamilies` | `FontFamilies` | Specifies font families to set. If a font family is not specified, it won't be changed. | | `forScripts` (optional) | `array<ScriptFontFamilies>` | Specifies font families to set for individual scripts. | #### `Page.setFontSizes` Experimental Set default font sizes. ###### Parameters | Name | Type | Description | |---|---|---| | `fontSizes` | `FontSizes` | Specifies font sizes to set. If a font size is not specified, it won't be changed. | #### `Page.setDocumentContent` Sets given markup as the document's HTML. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Frame id to set HTML for. | | `html` | `string` | HTML content to set. | #### `Page.setDownloadBehavior` Experimental Deprecated Set the behavior when downloading a file. ###### Parameters | Name | Type | Description | |---|---|---| | `behavior` | `string` | Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny). | | `downloadPath` (optional) | `string` | The default path to save downloaded files to. This is required if behavior is set to 'allow' | #### `Page.setGeolocationOverride` Deprecated Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable. Redirects to: Emulation ###### Parameters | Name | Type | Description | |---|---|---| | `latitude` (optional) | `number` | Mock latitude | | `longitude` (optional) | `number` | Mock longitude | | `accuracy` (optional) | `number` | Mock accuracy | #### `Page.setLifecycleEventsEnabled` Controls whether page will emit lifecycle events. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | If true, starts emitting lifecycle events. | #### `Page.setTouchEmulationEnabled` Experimental Deprecated Toggles mouse event-based touch event emulation. Redirects to: Emulation ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | Whether the touch event emulation should be enabled. | | `configuration` (optional) | `string` | Touch/gesture events configuration. Default: current platform. | #### `Page.startScreencast` Experimental Starts sending each frame using the `screencastFrame` event. ###### Parameters | Name | Type | Description | |---|---|---| | `format` (optional) | `string` | Image compression format. | | `quality` (optional) | `integer` | Compression quality from range \[0..100\]. | | `maxWidth` (optional) | `integer` | Maximum screenshot width. | | `maxHeight` (optional) | `integer` | Maximum screenshot height. | | `everyNthFrame` (optional) | `integer` | Send every n-th frame. | #### `Page.stopLoading` Force the page stop all navigations and pending resource fetches. #### `Page.crash` Experimental Crashes renderer on the IO thread, generates minidumps. #### `Page.close` Tries to close page, running its beforeunload hooks, if any. #### `Page.setWebLifecycleState` Experimental Tries to update the web lifecycle state of the page. It will transition the page to the given state according to: https://github.com/WICG/web-lifecycle/ ###### Parameters | Name | Type | Description | |---|---|---| | `state` | `string` | Target lifecycle state | #### `Page.stopScreencast` Experimental Stops sending each frame in the `screencastFrame`. #### `Page.produceCompilationCache` Experimental Requests backend to produce compilation cache for the specified scripts. `scripts` are appended to the list of scripts for which the cache would be produced. The list may be reset during page navigation. When script with a matching URL is encountered, the cache is optionally produced upon backend discretion, based on internal heuristics. See also: `Page.compilationCacheProduced`. ###### Parameters | Name | Type | Description | |---|---|---| | `scripts` | `array<CompilationCacheParams>` | | #### `Page.addCompilationCache` Experimental Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | | | `data` | `binary` | Base64-encoded data | #### `Page.clearCompilationCache` Experimental Clears seeded compilation cache. #### `Page.setSPCTransactionMode` Experimental Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode ###### Parameters | Name | Type | Description | |---|---|---| | `mode` | `string` | | #### `Page.setRPHRegistrationMode` Experimental Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation ###### Parameters | Name | Type | Description | |---|---|---| | `mode` | `string` | | #### `Page.generateTestReport` Experimental Generates a report for testing. ###### Parameters | Name | Type | Description | |---|---|---| | `message` | `string` | Message to be displayed in the report. | | `group` (optional) | `string` | Specifies the endpoint group to deliver the report to. | #### `Page.waitForDebugger` Experimental Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger. #### `Page.setInterceptFileChooserDialog` Intercept file chooser requests and transfer control to protocol clients. When file chooser interception is enabled, native file chooser dialog is not shown. Instead, a protocol event `Page.fileChooserOpened` is emitted. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | | | `cancel` (optional) Experimental | `boolean` | If true, cancels the dialog by emitting relevant events (if any) in addition to not showing it if the interception is enabled (default: false). | #### `Page.setPrerenderingAllowed` Experimental Enable/disable prerendering manually. This command is a short-term solution for https://crbug.com/1440085. See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0\_wpA for more details. TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets. ###### Parameters | Name | Type | Description | |---|---|---| | `isAllowed` | `boolean` | | #### `Page.getAnnotatedPageContent` Experimental Get the annotated page content for the main frame. This is an experimental command that is subject to change. ###### Parameters | Name | Type | Description | |---|---|---| | `includeActionableInformation` (optional) | `boolean` | Whether to include actionable information. Defaults to true. | ###### Return Object | Name | Type | Description | |---|---|---| | `content` | `binary` | The annotated page content as a base64 encoded protobuf. The format is defined by the `AnnotatedPageContent` message in components/optimization\_guide/proto/features/common\_quality\_data.proto | ## Events #### `Page.domContentEventFired` ###### Parameters | Name | Type | Description | |---|---|---| | `timestamp` | `Network.MonotonicTime` | | #### `Page.fileChooserOpened` Emitted only when `page.interceptFileChooser` is enabled. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` Experimental | `FrameId` | Id of the frame containing input node. | | `mode` | `string` | Input mode. | | `backendNodeId` (optional) Experimental | `DOM.BackendNodeId` | Input node id. Only present for file choosers opened via an `<input type="file">` element. | #### `Page.frameAttached` Fired when frame has been attached to its parent. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has been attached. | | `parentFrameId` | `FrameId` | Parent frame identifier. | | `stack` (optional) | `Runtime.StackTrace` | JavaScript stack trace of when frame was attached, only set if frame initiated from script. | #### `Page.frameClearedScheduledNavigation` Deprecated Fired when frame no longer has a scheduled navigation. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has cleared its scheduled navigation. | #### `Page.frameDetached` Fired when frame has been detached from its parent. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has been detached. | | `reason` Experimental | `string` | | #### `Page.frameSubtreeWillBeDetached` Experimental Fired before frame subtree is detached. Emitted before any frame of the subtree is actually detached. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that is the root of the subtree that will be detached. | #### `Page.frameNavigated` Fired once navigation of the frame has completed. Frame is now associated with the new loader. ###### Parameters | Name | Type | Description | |---|---|---| | `frame` | `Frame` | Frame object. | | `type` Experimental | `NavigationType` | | #### `Page.documentOpened` Experimental Fired when opening document to write to. ###### Parameters | Name | Type | Description | |---|---|---| | `frame` | `Frame` | Frame object. | #### `Page.frameResized` Experimental #### `Page.frameStartedNavigating` Experimental Fired when a navigation starts. This event is fired for both renderer-initiated and browser-initiated navigations. For renderer-initiated navigations, the event is fired after `frameRequestedNavigation`. Navigation may still be cancelled after the event is issued. Multiple events can be fired for a single navigation, for example, when a same-document navigation becomes a cross-document navigation (such as in the case of a frameset). ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | ID of the frame that is being navigated. | | `url` | `string` | The URL the navigation started with. The final URL can be different. | | `loaderId` | `Network.LoaderId` | Loader identifier. Even though it is present in case of same-document navigation, the previously committed loaderId would not change unless the navigation changes from a same-document to a cross-document navigation. | | `navigationType` | `string` | | #### `Page.frameRequestedNavigation` Experimental Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that is being navigated. | | `reason` | `ClientNavigationReason` | The reason for the navigation. | | `url` | `string` | The destination URL for the requested navigation. | | `disposition` | `ClientNavigationDisposition` | The disposition for the navigation. | #### `Page.frameScheduledNavigation` Deprecated Fired when frame schedules a potential navigation. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has scheduled a navigation. | | `delay` | `number` | Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start. | | `reason` | `ClientNavigationReason` | The reason for the navigation. | | `url` | `string` | The destination URL for the scheduled navigation. | #### `Page.frameStartedLoading` Experimental Fired when frame has started loading. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has started loading. | #### `Page.frameStoppedLoading` Experimental Fired when frame has stopped loading. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that has stopped loading. | #### `Page.downloadWillBegin` Experimental Deprecated Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame that caused download to begin. | | `guid` | `string` | Global unique identifier of the download. | | `url` | `string` | URL of the resource being downloaded. | | `suggestedFilename` | `string` | Suggested file name of the resource (the actual name of the file saved on disk may differ). | #### `Page.downloadProgress` Experimental Deprecated Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead. ###### Parameters | Name | Type | Description | |---|---|---| | `guid` | `string` | Global unique identifier of the download. | | `totalBytes` | `number` | Total expected bytes to download. | | `receivedBytes` | `number` | Total bytes received. | | `state` | `string` | Download status. | #### `Page.interstitialHidden` Fired when interstitial page was hidden #### `Page.interstitialShown` Fired when interstitial page was shown #### `Page.javascriptDialogClosed` Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` Experimental | `FrameId` | Frame id. | | `result` | `boolean` | Whether dialog was confirmed. | | `userInput` | `string` | User input in case of prompt. | #### `Page.javascriptDialogOpening` Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | Frame url. | | `frameId` Experimental | `FrameId` | Frame id. | | `message` | `string` | Message that will be displayed by the dialog. | | `type` | `DialogType` | Dialog type. | | `hasBrowserHandler` | `boolean` | True iff browser is capable showing or acting on the given dialog. When browser has no dialog handler for given target, calling alert while Page domain is engaged will stall the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog. | | `defaultPrompt` (optional) | `string` | Default dialog prompt. | #### `Page.lifecycleEvent` Fired for lifecycle events (navigation, load, paint, etc) in the current target (including local frames). ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame. | | `loaderId` | `Network.LoaderId` | Loader identifier. Empty string if the request is fetched from worker. | | `name` | `string` | | | `timestamp` | `Network.MonotonicTime` | | #### `Page.backForwardCacheNotUsed` Experimental Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do not assume any ordering with the Page.frameNavigated event. This event is fired only for main-frame history navigation where the document changes (non-same-document navigations), when bfcache navigation fails. ###### Parameters | Name | Type | Description | |---|---|---| | `loaderId` | `Network.LoaderId` | The loader id for the associated navigation. | | `frameId` | `FrameId` | The frame id of the associated frame. | | `notRestoredExplanations` | `array<BackForwardCacheNotRestoredExplanation>` | Array of reasons why the page could not be cached. This must not be empty. | | `notRestoredExplanationsTree` (optional) | `BackForwardCacheNotRestoredExplanationTree` | Tree structure of reasons why the page could not be cached for each frame. | #### `Page.loadEventFired` ###### Parameters | Name | Type | Description | |---|---|---| | `timestamp` | `Network.MonotonicTime` | | #### `Page.navigatedWithinDocument` Experimental Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation. ###### Parameters | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | Id of the frame. | | `url` | `string` | Frame's new url. | | `navigationType` | `string` | Navigation type | #### `Page.screencastFrame` Experimental Compressed image data requested by the `startScreencast`. ###### Parameters | Name | Type | Description | |---|---|---| | `data` | `binary` | Base64-encoded compressed image. | | `metadata` | `ScreencastFrameMetadata` | Screencast frame metadata. | | `sessionId` | `integer` | Frame number. | #### `Page.screencastVisibilityChanged` Experimental Fired when the page with currently enabled screencast was shown or hidden `. ###### Parameters | Name | Type | Description | |---|---|---| | `visible` | `boolean` | True if the page is visible. | #### `Page.windowOpen` Fired when a new window is going to be opened, via window.open(), link click, form submission, etc. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | The URL for the new window. | | `windowName` | `string` | Window name. | | `windowFeatures` | `array<string>` | An array of enabled window features. | | `userGesture` | `boolean` | Whether or not it was triggered by user gesture. | #### `Page.compilationCacheProduced` Experimental Issued for every compilation cache generated. ###### Parameters | Name | Type | Description | |---|---|---| | `url` | `string` | | | `data` | `binary` | Base64-encoded data | ## Types #### `FrameId` (string) Unique frame identifier. #### `AdFrameType` (string) Experimental Indicates whether a frame has been identified as an ad. ###### Allowed Values - `none` - `child` - `root` #### `AdFrameExplanation` (string) Experimental ###### Allowed Values - `ParentIsAd` - `CreatedByAdScript` - `MatchedBlockingRule` #### `AdFrameStatus` (object) Experimental Indicates whether a frame has been identified as an ad and why. ###### Properties | Name | Type | Description | |---|---|---| | `adFrameType` | `AdFrameType` | | | `explanations` (optional) | `array<AdFrameExplanation>` | | #### `AdScriptId` (object) Experimental Identifies the script which caused a script or frame to be labelled as an ad. ###### Properties | Name | Type | Description | |---|---|---| | `scriptId` | `Runtime.ScriptId` | Script Id of the script which caused a script or frame to be labelled as an ad. | | `debuggerId` | `Runtime.UniqueDebuggerId` | Id of scriptId's debugger. | #### `AdScriptAncestry` (object) Experimental Encapsulates the script ancestry and the root script filterlist rule that caused the frame to be labelled as an ad. Only created when `ancestryChain` is not empty. ###### Properties | Name | Type | Description | |---|---|---| | `ancestryChain` | `array<AdScriptId>` | A chain of `AdScriptId`s representing the ancestry of an ad script that led to the creation of a frame. The chain is ordered from the script itself (lower level) up to its root ancestor that was flagged by filterlist. | | `rootScriptFilterlistRule` (optional) | `string` | The filterlist rule that caused the root (last) script in `ancestryChain` to be ad-tagged. Only populated if the rule is available. | #### `SecureContextType` (string) Experimental Indicates whether the frame is a secure context and why it is the case. ###### Allowed Values - `Secure` - `SecureLocalhost` - `InsecureScheme` - `InsecureAncestor` #### `CrossOriginIsolatedContextType` (string) Experimental Indicates whether the frame is cross-origin isolated and why it is the case. ###### Allowed Values - `Isolated` - `NotIsolated` - `NotIsolatedFeatureDisabled` #### `GatedAPIFeatures` (string) Experimental ###### Allowed Values - `SharedArrayBuffers` - `SharedArrayBuffersTransferAllowed` - `PerformanceMeasureMemory` - `PerformanceProfile` #### `PermissionsPolicyFeature` (string) Experimental All Permissions Policy features. This enum should match the one defined in services/network/public/cpp/permissions\_policy/permissions\_policy\_features.json5. LINT.IfChange(PermissionsPolicyFeature) ###### Allowed Values - `accelerometer` - `all-screens-capture` - `ambient-light-sensor` - `aria-notify` - `attribution-reporting` - `autofill` - `autoplay` - `bluetooth` - `browsing-topics` - `camera` - `captured-surface-control` - `ch-dpr` - `ch-device-memory` - `ch-downlink` - `ch-ect` - `ch-prefers-color-scheme` - `ch-prefers-reduced-motion` - `ch-prefers-reduced-transparency` - `ch-rtt` - `ch-save-data` - `ch-ua` - `ch-ua-arch` - `ch-ua-bitness` - `ch-ua-high-entropy-values` - `ch-ua-platform` - `ch-ua-model` - `ch-ua-mobile` - `ch-ua-form-factors` - `ch-ua-full-version` - `ch-ua-full-version-list` - `ch-ua-platform-version` - `ch-ua-wow64` - `ch-viewport-height` - `ch-viewport-width` - `ch-width` - `clipboard-read` - `clipboard-write` - `compute-pressure` - `controlled-frame` - `cross-origin-isolated` - `deferred-fetch` - `deferred-fetch-minimal` - `device-attributes` - `digital-credentials-create` - `digital-credentials-get` - `direct-sockets` - `direct-sockets-multicast` - `direct-sockets-private` - `display-capture` - `document-domain` - `encrypted-media` - `execution-while-out-of-viewport` - `execution-while-not-rendered` - `fenced-unpartitioned-storage-read` - `focus-without-user-activation` - `fullscreen` - `frobulate` - `gamepad` - `geolocation` - `gyroscope` - `hid` - `identity-credentials-get` - `idle-detection` - `interest-cohort` - `join-ad-interest-group` - `keyboard-map` - `language-detector` - `language-model` - `local-fonts` - `local-network` - `local-network-access` - `loopback-network` - `magnetometer` - `manual-text` - `media-playback-while-not-visible` - `microphone` - `midi` - `on-device-speech-recognition` - `otp-credentials` - `payment` - `picture-in-picture` - `private-aggregation` - `private-state-token-issuance` - `private-state-token-redemption` - `publickey-credentials-create` - `publickey-credentials-get` - `record-ad-auction-events` - `rewriter` - `run-ad-auction` - `screen-wake-lock` - `serial` - `shared-storage` - `shared-storage-select-url` - `smart-card` - `speaker-selection` - `storage-access` - `sub-apps` - `summarizer` - `sync-xhr` - `translator` - `unload` - `usb` - `usb-unrestricted` - `vertical-scroll` - `web-app-installation` - `web-printing` - `web-share` - `window-management` - `writer` - `xr-spatial-tracking` #### `PermissionsPolicyBlockReason` (string) Experimental Reason for a permissions policy feature to be disabled. ###### Allowed Values - `Header` - `IframeAttribute` - `InFencedFrameTree` - `InIsolatedApp` #### `PermissionsPolicyBlockLocator` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `frameId` | `FrameId` | | | `blockReason` | `PermissionsPolicyBlockReason` | | #### `PermissionsPolicyFeatureState` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `feature` | `PermissionsPolicyFeature` | | | `allowed` | `boolean` | | | `locator` (optional) | `PermissionsPolicyBlockLocator` | | #### `OriginTrialTokenStatus` (string) Experimental Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token. ###### Allowed Values - `Success` - `NotSupported` - `Insecure` - `Expired` - `WrongOrigin` - `InvalidSignature` - `Malformed` - `WrongVersion` - `FeatureDisabled` - `TokenDisabled` - `FeatureDisabledForUser` - `UnknownTrial` #### `OriginTrialStatus` (string) Experimental Status for an Origin Trial. ###### Allowed Values - `Enabled` - `ValidTokenNotProvided` - `OSNotSupported` - `TrialNotAllowed` #### `OriginTrialUsageRestriction` (string) Experimental ###### Allowed Values - `None` - `Subset` #### `OriginTrialToken` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `origin` | `string` | | | `matchSubDomains` | `boolean` | | | `trialName` | `string` | | | `expiryTime` | `Network.TimeSinceEpoch` | | | `isThirdParty` | `boolean` | | | `usageRestriction` | `OriginTrialUsageRestriction` | | #### `OriginTrialTokenWithStatus` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `rawTokenText` | `string` | | | `parsedToken` (optional) | `OriginTrialToken` | `parsedToken` is present only when the token is extractable and parsable. | | `status` | `OriginTrialTokenStatus` | | #### `OriginTrial` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `trialName` | `string` | | | `status` | `OriginTrialStatus` | | | `tokensWithStatus` | `array<OriginTrialTokenWithStatus>` | | #### `SecurityOriginDetails` (object) Experimental Additional information about the frame document's security origin. ###### Properties | Name | Type | Description | |---|---|---| | `isLocalhost` | `boolean` | Indicates whether the frame document's security origin is one of the local hostnames (e.g. "localhost") or IP addresses (IPv4 127.0.0.0/8 or IPv6 ::1). | #### `Frame` (object) Information about the Frame on the page. ###### Properties | Name | Type | Description | |---|---|---| | `id` | `FrameId` | Frame unique identifier. | | `parentId` (optional) | `FrameId` | Parent frame identifier. | | `loaderId` | `Network.LoaderId` | Identifier of the loader associated with this frame. | | `name` (optional) | `string` | Frame's name as specified in the tag. | | `url` | `string` | Frame document's URL without fragment. | | `urlFragment` (optional) Experimental | `string` | Frame document's URL fragment including the '#'. | | `domainAndRegistry` Experimental | `string` | Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk" | | `securityOrigin` | `string` | Frame document's security origin. | | `securityOriginDetails` (optional) Experimental | `SecurityOriginDetails` | Additional details about the frame document's security origin. | | `mimeType` | `string` | Frame document's mimeType as determined by the browser. | | `unreachableUrl` (optional) Experimental | `string` | If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment. | | `adFrameStatus` (optional) Experimental | `AdFrameStatus` | Indicates whether this frame was tagged as an ad and why. | | `secureContextType` Experimental | `SecureContextType` | Indicates whether the main document is a secure context and explains why that is the case. | | `crossOriginIsolatedContextType` Experimental | `CrossOriginIsolatedContextType` | Indicates whether this is a cross origin isolated context. | | `gatedAPIFeatures` Experimental | `array<GatedAPIFeatures>` | Indicated which gated APIs / features are available. | #### `FrameResource` (object) Experimental Information about the Resource on the page. ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | Resource URL. | | `type` | `Network.ResourceType` | Type of this resource. | | `mimeType` | `string` | Resource mimeType as determined by the browser. | | `lastModified` (optional) | `Network.TimeSinceEpoch` | last-modified timestamp as reported by server. | | `contentSize` (optional) | `number` | Resource content size. | | `failed` (optional) | `boolean` | True if the resource failed to load. | | `canceled` (optional) | `boolean` | True if the resource was canceled during loading. | #### `FrameResourceTree` (object) Experimental Information about the Frame hierarchy along with their cached resources. ###### Properties | Name | Type | Description | |---|---|---| | `frame` | `Frame` | Frame information for this tree item. | | `childFrames` (optional) | `array<FrameResourceTree>` | Child frames. | | `resources` | `array<FrameResource>` | Information about frame resources. | #### `FrameTree` (object) Information about the Frame hierarchy. ###### Properties | Name | Type | Description | |---|---|---| | `frame` | `Frame` | Frame information for this tree item. | | `childFrames` (optional) | `array<FrameTree>` | Child frames. | #### `ScriptIdentifier` (string) Unique script identifier. #### `TransitionType` (string) Transition type. ###### Allowed Values - `link` - `typed` - `address_bar` - `auto_bookmark` - `auto_subframe` - `manual_subframe` - `generated` - `auto_toplevel` - `form_submit` - `reload` - `keyword` - `keyword_generated` - `other` #### `NavigationEntry` (object) Navigation history entry. ###### Properties | Name | Type | Description | |---|---|---| | `id` | `integer` | Unique id of the navigation history entry. | | `url` | `string` | URL of the navigation history entry. | | `userTypedURL` | `string` | URL that the user typed in the url bar. | | `title` | `string` | Title of the navigation history entry. | | `transitionType` | `TransitionType` | Transition type. | #### `ScreencastFrameMetadata` (object) Experimental Screencast frame metadata. ###### Properties | Name | Type | Description | |---|---|---| | `offsetTop` | `number` | Top offset in DIP. | | `pageScaleFactor` | `number` | Page scale factor. | | `deviceWidth` | `number` | Device screen width in DIP. | | `deviceHeight` | `number` | Device screen height in DIP. | | `scrollOffsetX` | `number` | Position of horizontal scroll in CSS pixels. | | `scrollOffsetY` | `number` | Position of vertical scroll in CSS pixels. | | `timestamp` (optional) | `Network.TimeSinceEpoch` | Frame swap timestamp. | #### `DialogType` (string) Javascript dialog type. ###### Allowed Values - `alert` - `confirm` - `prompt` - `beforeunload` #### `AppManifestError` (object) Error while paring app manifest. ###### Properties | Name | Type | Description | |---|---|---| | `message` | `string` | Error message. | | `critical` | `integer` | If critical, this is a non-recoverable parse error. | | `line` | `integer` | Error line. | | `column` | `integer` | Error column. | #### `AppManifestParsedProperties` (object) Experimental Parsed app manifest properties. ###### Properties | Name | Type | Description | |---|---|---| | `scope` | `string` | Computed scope value | #### `LayoutViewport` (object) Layout viewport position and dimensions. ###### Properties | Name | Type | Description | |---|---|---| | `pageX` | `integer` | Horizontal offset relative to the document (CSS pixels). | | `pageY` | `integer` | Vertical offset relative to the document (CSS pixels). | | `clientWidth` | `integer` | Width (CSS pixels), excludes scrollbar if present. | | `clientHeight` | `integer` | Height (CSS pixels), excludes scrollbar if present. | #### `VisualViewport` (object) Visual viewport position, dimensions, and scale. ###### Properties | Name | Type | Description | |---|---|---| | `offsetX` | `number` | Horizontal offset relative to the layout viewport (CSS pixels). | | `offsetY` | `number` | Vertical offset relative to the layout viewport (CSS pixels). | | `pageX` | `number` | Horizontal offset relative to the document (CSS pixels). | | `pageY` | `number` | Vertical offset relative to the document (CSS pixels). | | `clientWidth` | `number` | Width (CSS pixels), excludes scrollbar if present. | | `clientHeight` | `number` | Height (CSS pixels), excludes scrollbar if present. | | `scale` | `number` | Scale relative to the ideal viewport (size at width=device-width). | | `zoom` (optional) | `number` | Page zoom factor (CSS to device independent pixels ratio). | #### `Viewport` (object) Viewport for capturing screenshot. ###### Properties | Name | Type | Description | |---|---|---| | `x` | `number` | X offset in device independent pixels (dip). | | `y` | `number` | Y offset in device independent pixels (dip). | | `width` | `number` | Rectangle width in device independent pixels (dip). | | `height` | `number` | Rectangle height in device independent pixels (dip). | | `scale` | `number` | Page scale factor. | #### `FontFamilies` (object) Experimental Generic font families collection. ###### Properties | Name | Type | Description | |---|---|---| | `standard` (optional) | `string` | The standard font-family. | | `fixed` (optional) | `string` | The fixed font-family. | | `serif` (optional) | `string` | The serif font-family. | | `sansSerif` (optional) | `string` | The sansSerif font-family. | | `cursive` (optional) | `string` | The cursive font-family. | | `fantasy` (optional) | `string` | The fantasy font-family. | | `math` (optional) | `string` | The math font-family. | #### `ScriptFontFamilies` (object) Experimental Font families collection for a script. ###### Properties | Name | Type | Description | |---|---|---| | `script` | `string` | Name of the script which these font families are defined for. | | `fontFamilies` | `FontFamilies` | Generic font families collection for the script. | #### `FontSizes` (object) Experimental Default font sizes. ###### Properties | Name | Type | Description | |---|---|---| | `standard` (optional) | `integer` | Default standard font size. | | `fixed` (optional) | `integer` | Default fixed font size. | #### `ClientNavigationReason` (string) Experimental ###### Allowed Values - `anchorClick` - `formSubmissionGet` - `formSubmissionPost` - `httpHeaderRefresh` - `initialFrameNavigation` - `metaTagRefresh` - `other` - `pageBlockInterstitial` - `reload` - `scriptInitiated` #### `ClientNavigationDisposition` (string) Experimental ###### Allowed Values - `currentTab` - `newTab` - `newWindow` - `download` #### `InstallabilityErrorArgument` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `name` | `string` | Argument name (e.g. name:'minimum-icon-size-in-pixels'). | | `value` | `string` | Argument value (e.g. value:'64'). | #### `InstallabilityError` (object) Experimental The installability error ###### Properties | Name | Type | Description | |---|---|---| | `errorId` | `string` | The error id (e.g. 'manifest-missing-suitable-icon'). | | `errorArguments` | `array<InstallabilityErrorArgument>` | The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}). | #### `ReferrerPolicy` (string) Experimental The referring-policy used for the navigation. ###### Allowed Values - `noReferrer` - `noReferrerWhenDowngrade` - `origin` - `originWhenCrossOrigin` - `sameOrigin` - `strictOrigin` - `strictOriginWhenCrossOrigin` - `unsafeUrl` #### `CompilationCacheParams` (object) Experimental Per-script compilation cache parameters for `Page.produceCompilationCache` ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | The URL of the script to produce a compilation cache entry for. | | `eager` (optional) | `boolean` | A hint to the backend whether eager compilation is recommended. (the actual compilation mode used is upon backend discretion). | #### `FileFilter` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `name` (optional) | `string` | | | `accepts` (optional) | `array<string>` | | #### `FileHandler` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `action` | `string` | | | `name` | `string` | | | `icons` (optional) | `array<ImageResource>` | | | `accepts` (optional) | `array<FileFilter>` | Mimic a map, name is the key, accepts is the value. | | `launchType` | `string` | Won't repeat the enums, using string for easy comparison. Same as the other enums below. | #### `ImageResource` (object) Experimental The image definition used in both icon and screenshot. ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | The src field in the definition, but changing to url in favor of consistency. | | `sizes` (optional) | `string` | | | `type` (optional) | `string` | | #### `LaunchHandler` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `clientMode` | `string` | | #### `ProtocolHandler` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `protocol` | `string` | | | `url` | `string` | | #### `RelatedApplication` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `id` (optional) | `string` | | | `url` | `string` | | #### `ScopeExtension` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `origin` | `string` | Instead of using tuple, this field always returns the serialized string for easy understanding and comparison. | | `hasOriginWildcard` | `boolean` | | #### `Screenshot` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `image` | `ImageResource` | | | `formFactor` | `string` | | | `label` (optional) | `string` | | #### `ShareTarget` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `action` | `string` | | | `method` | `string` | | | `enctype` | `string` | | | `title` (optional) | `string` | Embed the ShareTargetParams | | `text` (optional) | `string` | | | `url` (optional) | `string` | | | `files` (optional) | `array<FileFilter>` | | #### `Shortcut` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `name` | `string` | | | `url` | `string` | | #### `WebAppManifest` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `backgroundColor` (optional) | `string` | | | `description` (optional) | `string` | The extra description provided by the manifest. | | `dir` (optional) | `string` | | | `display` (optional) | `string` | | | `displayOverrides` (optional) | `array<string>` | The overrided display mode controlled by the user. | | `fileHandlers` (optional) | `array<FileHandler>` | The handlers to open files. | | `icons` (optional) | `array<ImageResource>` | | | `id` (optional) | `string` | | | `lang` (optional) | `string` | | | `launchHandler` (optional) | `LaunchHandler` | TODO(crbug.com/1231886): This field is non-standard and part of a Chrome experiment. See: https://github.com/WICG/web-app-launch/blob/main/launch\_handler.md | | `name` (optional) | `string` | | | `orientation` (optional) | `string` | | | `preferRelatedApplications` (optional) | `boolean` | | | `protocolHandlers` (optional) | `array<ProtocolHandler>` | The handlers to open protocols. | | `relatedApplications` (optional) | `array<RelatedApplication>` | | | `scope` (optional) | `string` | | | `scopeExtensions` (optional) | `array<ScopeExtension>` | Non-standard, see https://github.com/WICG/manifest-incubations/blob/gh-pages/scope\_extensions-explainer.md | | `screenshots` (optional) | `array<Screenshot>` | The screenshots used by chromium. | | `shareTarget` (optional) | `ShareTarget` | | | `shortName` (optional) | `string` | | | `shortcuts` (optional) | `array<Shortcut>` | | | `startUrl` (optional) | `string` | | | `themeColor` (optional) | `string` | | #### `NavigationResponseEntry` (object) Experimental A single navigation response entry (one per redirect hop or final response). ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | The URL for this response. | | `statusCode` | `integer` | HTTP status code (e.g. 200, 301, 302). | | `headers` | `object` | Response headers as key-value pairs. | #### `FetchRedirectEntry` (object) Experimental A single redirect entry in a fetch redirect chain. ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | URL that issued the redirect. | | `statusCode` | `integer` | HTTP status code of the redirect (301, 302, 307, 308). | | `headers` | `object` | Response headers of the redirect response. | #### `NavigationType` (string) Experimental The type of a frameNavigated event. ###### Allowed Values - `Navigation` - `BackForwardCacheRestore` #### `BackForwardCacheNotRestoredReason` (string) Experimental List of not restored reasons for back-forward cache. ###### Allowed Values - `NotPrimaryMainFrame` - `BackForwardCacheDisabled` - `RelatedActiveContentsExist` - `HTTPStatusNotOK` - `SchemeNotHTTPOrHTTPS` - `Loading` - `WasGrantedMediaAccess` - `DisableForRenderFrameHostCalled` - `DomainNotAllowed` - `HTTPMethodNotGET` - `SubframeIsNavigating` - `Timeout` - `CacheLimit` - `JavaScriptExecution` - `RendererProcessKilled` - `RendererProcessCrashed` - `SchedulerTrackedFeatureUsed` - `ConflictingBrowsingInstance` - `CacheFlushed` - `ServiceWorkerVersionActivation` - `SessionRestored` - `ServiceWorkerPostMessage` - `EnteredBackForwardCacheBeforeServiceWorkerHostAdded` - `RenderFrameHostReused_SameSite` - `RenderFrameHostReused_CrossSite` - `ServiceWorkerClaim` - `IgnoreEventAndEvict` - `HaveInnerContents` - `TimeoutPuttingInCache` - `BackForwardCacheDisabledByLowMemory` - `BackForwardCacheDisabledByCommandLine` - `NetworkRequestDatapipeDrainedAsBytesConsumer` - `NetworkRequestRedirected` - `NetworkRequestTimeout` - `NetworkExceedsBufferLimit` - `NavigationCancelledWhileRestoring` - `NotMostRecentNavigationEntry` - `BackForwardCacheDisabledForPrerender` - `UserAgentOverrideDiffers` - `ForegroundCacheLimit` - `ForwardCacheDisabled` - `BrowsingInstanceNotSwapped` - `BackForwardCacheDisabledForDelegate` - `UnloadHandlerExistsInMainFrame` - `UnloadHandlerExistsInSubFrame` - `ServiceWorkerUnregistration` - `CacheControlNoStore` - `CacheControlNoStoreCookieModified` - `CacheControlNoStoreHTTPOnlyCookieModified` - `NoResponseHead` - `Unknown` - `ActivationNavigationsDisallowedForBug1234857` - `ErrorDocument` - `FencedFramesEmbedder` - `CookieDisabled` - `HTTPAuthRequired` - `CookieFlushed` - `BroadcastChannelOnMessage` - `WebViewSettingsChanged` - `WebViewJavaScriptObjectChanged` - `WebViewMessageListenerInjected` - `WebViewSafeBrowsingAllowlistChanged` - `WebViewDocumentStartJavascriptChanged` - `WebSocket` - `WebTransport` - `WebRTC` - `MainResourceHasCacheControlNoStore` - `MainResourceHasCacheControlNoCache` - `SubresourceHasCacheControlNoStore` - `SubresourceHasCacheControlNoCache` - `ContainsPlugins` - `DocumentLoaded` - `OutstandingNetworkRequestOthers` - `RequestedMIDIPermission` - `RequestedAudioCapturePermission` - `RequestedVideoCapturePermission` - `RequestedBackForwardCacheBlockedSensors` - `RequestedBackgroundWorkPermission` - `BroadcastChannel` - `WebXR` - `SharedWorker` - `SharedWorkerMessage` - `SharedWorkerWithNoActiveClient` - `WebLocks` - `WebLocksContention` - `WebHID` - `WebBluetooth` - `WebShare` - `RequestedStorageAccessGrant` - `WebNfc` - `OutstandingNetworkRequestFetch` - `OutstandingNetworkRequestXHR` - `AppBanner` - `Printing` - `WebDatabase` - `PictureInPicture` - `SpeechRecognizer` - `IdleManager` - `PaymentManager` - `SpeechSynthesis` - `KeyboardLock` - `WebOTPService` - `OutstandingNetworkRequestDirectSocket` - `InjectedJavascript` - `InjectedStyleSheet` - `KeepaliveRequest` - `IndexedDBEvent` - `Dummy` - `JsNetworkRequestReceivedCacheControlNoStoreResource` - `WebRTCUsedWithCCNS` - `WebTransportUsedWithCCNS` - `WebSocketUsedWithCCNS` - `SmartCard` - `LiveMediaStreamTrack` - `UnloadHandler` - `ParserAborted` - `ContentSecurityHandler` - `ContentWebAuthenticationAPI` - `ContentFileChooser` - `ContentSerial` - `ContentFileSystemAccess` - `ContentMediaDevicesDispatcherHost` - `ContentWebBluetooth` - `ContentWebUSB` - `ContentMediaSessionService` - `ContentScreenReader` - `ContentDiscarded` - `EmbedderPopupBlockerTabHelper` - `EmbedderSafeBrowsingTriggeredPopupBlocker` - `EmbedderSafeBrowsingThreatDetails` - `EmbedderAppBannerManager` - `EmbedderDomDistillerViewerSource` - `EmbedderDomDistillerSelfDeletingRequestDelegate` - `EmbedderOomInterventionTabHelper` - `EmbedderOfflinePage` - `EmbedderChromePasswordManagerClientBindCredentialManager` - `EmbedderPermissionRequestManager` - `EmbedderModalDialog` - `EmbedderExtensions` - `EmbedderExtensionMessaging` - `EmbedderExtensionMessagingForOpenPort` - `EmbedderExtensionSentMessageToCachedFrame` - `RequestedByWebViewClient` - `PostMessageByWebViewClient` - `CacheControlNoStoreDeviceBoundSessionTerminated` - `CacheLimitPrunedOnModerateMemoryPressure` - `CacheLimitPrunedOnCriticalMemoryPressure` #### `BackForwardCacheNotRestoredReasonType` (string) Experimental Types of not restored reasons for back-forward cache. ###### Allowed Values - `SupportPending` - `PageSupportNeeded` - `Circumstantial` #### `BackForwardCacheBlockingDetails` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `url` (optional) | `string` | Url of the file where blockage happened. Optional because of tests. | | `function` (optional) | `string` | Function name where blockage happened. Optional because of anonymous functions and tests. | | `lineNumber` | `integer` | Line number in the script (0-based). | | `columnNumber` | `integer` | Column number in the script (0-based). | #### `BackForwardCacheNotRestoredExplanation` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `type` | `BackForwardCacheNotRestoredReasonType` | Type of the reason | | `reason` | `BackForwardCacheNotRestoredReason` | Not restored reason | | `context` (optional) | `string` | Context associated with the reason. The meaning of this context is dependent on the reason: - EmbedderExtensionSentMessageToCachedFrame: the extension ID. | | `details` (optional) | `array<BackForwardCacheBlockingDetails>` | | #### `BackForwardCacheNotRestoredExplanationTree` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `url` | `string` | URL of each frame | | `explanations` | `array<BackForwardCacheNotRestoredExplanation>` | Not restored reasons of each frame | | `children` | `array<BackForwardCacheNotRestoredExplanationTree>` | Array of children frame |