# 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. Input # Input - [Commands (13)](#commands) - [Events (1)](#events) - [Types (6)](#types) No symbols match your filter. ## Commands #### `Input.dispatchDragEvent` Experimental Dispatches a drag event into the page. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Type of the drag event. | | `x` | `number` | X coordinate of the event relative to the main frame's viewport in CSS pixels. | | `y` | `number` | Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. | | `data` | `DragData` | | | `modifiers` (optional) | `integer` | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). | #### `Input.dispatchKeyEvent` Dispatches a key event to the page. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Type of the key event. | | `modifiers` (optional) | `integer` | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). | | `timestamp` (optional) | `TimeSinceEpoch` | Time at which the event occurred. | | `text` (optional) | `string` | Text as generated by processing a virtual key code with a keyboard layout. Not needed for for `keyUp` and `rawKeyDown` events (default: "") | | `unmodifiedText` (optional) | `string` | Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: ""). | | `keyIdentifier` (optional) | `string` | Unique key identifier (e.g., 'U+0041') (default: ""). | | `code` (optional) | `string` | Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: ""). | | `key` (optional) | `string` | Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: ""). | | `windowsVirtualKeyCode` (optional) | `integer` | Windows virtual key code (default: 0). | | `nativeVirtualKeyCode` (optional) | `integer` | Native virtual key code (default: 0). | | `autoRepeat` (optional) | `boolean` | Whether the event was generated from auto repeat (default: false). | | `isKeypad` (optional) | `boolean` | Whether the event was generated from the keypad (default: false). | | `isSystemKey` (optional) | `boolean` | Whether the event was a system key event (default: false). | | `location` (optional) | `integer` | Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0). | | `commands` (optional) Experimental | `array<string>` | Editing commands to send with the key event (e.g., 'selectAll') (default: \[\]). These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third\_party/blink/renderer/core/editing/commands/editor\_command\_names.h for valid command names. | #### `Input.insertText` Experimental This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME. ###### Parameters | Name | Type | Description | |---|---|---| | `text` | `string` | The text to insert. | #### `Input.imeSetComposition` Experimental This method sets the current candidate text for IME. Use imeCommitComposition to commit the final text. Use imeSetComposition with empty string as text to cancel composition. ###### Parameters | Name | Type | Description | |---|---|---| | `text` | `string` | The text to insert | | `selectionStart` | `integer` | selection start | | `selectionEnd` | `integer` | selection end | | `replacementStart` (optional) | `integer` | replacement start | | `replacementEnd` (optional) | `integer` | replacement end | #### `Input.dispatchMouseEvent` Dispatches a mouse event to the page. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Type of the mouse event. | | `x` | `number` | X coordinate of the event relative to the main frame's viewport in CSS pixels. | | `y` | `number` | Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. | | `modifiers` (optional) | `integer` | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). | | `timestamp` (optional) | `TimeSinceEpoch` | Time at which the event occurred. | | `button` (optional) | `MouseButton` | Mouse button (default: "none"). | | `buttons` (optional) | `integer` | A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0. | | `clickCount` (optional) | `integer` | Number of times the mouse button was clicked (default: 0). | | `force` (optional) Experimental | `number` | The normalized pressure, which has a range of \[0,1\] (default: 0). | | `tangentialPressure` (optional) Experimental | `number` | The normalized tangential pressure, which has a range of \[-1,1\] (default: 0). | | `tiltX` (optional) | `number` | The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range \[-90,90\], a positive tiltX is to the right (default: 0). | | `tiltY` (optional) | `number` | The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range \[-90,90\], a positive tiltY is towards the user (default: 0). | | `twist` (optional) Experimental | `integer` | The clockwise rotation of a pen stylus around its own major axis, in degrees in the range \[0,359\] (default: 0). | | `deltaX` (optional) | `number` | X delta in CSS pixels for mouse wheel event (default: 0). | | `deltaY` (optional) | `number` | Y delta in CSS pixels for mouse wheel event (default: 0). | | `pointerType` (optional) | `string` | Pointer type (default: "mouse"). | #### `Input.dispatchTouchEvent` Dispatches a touch event to the page. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one. | | `touchPoints` | `array<TouchPoint>` | Active touch points on the touch device. One event per any changed point (compared to previous touch event in a sequence) is generated, emulating pressing/moving/releasing points one by one. | | `modifiers` (optional) | `integer` | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). | | `timestamp` (optional) | `TimeSinceEpoch` | Time at which the event occurred. | #### `Input.cancelDragging` Cancels any active dragging in the page. #### `Input.emulateTouchFromMouseEvent` Experimental Emulates touch event from the mouse event parameters. ###### Parameters | Name | Type | Description | |---|---|---| | `type` | `string` | Type of the mouse event. | | `x` | `integer` | X coordinate of the mouse pointer in DIP. | | `y` | `integer` | Y coordinate of the mouse pointer in DIP. | | `button` | `MouseButton` | Mouse button. Only "none", "left", "right" are supported. | | `timestamp` (optional) | `TimeSinceEpoch` | Time at which the event occurred (default: current time). | | `deltaX` (optional) | `number` | X delta in DIP for mouse wheel event (default: 0). | | `deltaY` (optional) | `number` | Y delta in DIP for mouse wheel event (default: 0). | | `modifiers` (optional) | `integer` | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). | | `clickCount` (optional) | `integer` | Number of times the mouse button was clicked (default: 0). | #### `Input.setIgnoreInputEvents` Ignores input events (useful while auditing page). ###### Parameters | Name | Type | Description | |---|---|---| | `ignore` | `boolean` | Ignores input events processing when set to true. | #### `Input.setInterceptDrags` Experimental Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events. Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`. ###### Parameters | Name | Type | Description | |---|---|---| | `enabled` | `boolean` | | #### `Input.synthesizePinchGesture` Experimental Synthesizes a pinch gesture over a time period by issuing appropriate touch events. ###### Parameters | Name | Type | Description | |---|---|---| | `x` | `number` | X coordinate of the start of the gesture in CSS pixels. | | `y` | `number` | Y coordinate of the start of the gesture in CSS pixels. | | `scaleFactor` | `number` | Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out). | | `relativeSpeed` (optional) | `integer` | Relative pointer speed in pixels per second (default: 800). | | `gestureSourceType` (optional) | `GestureSourceType` | Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type). | #### `Input.synthesizeScrollGesture` Experimental Synthesizes a scroll gesture over a time period by issuing appropriate touch events. ###### Parameters | Name | Type | Description | |---|---|---| | `x` | `number` | X coordinate of the start of the gesture in CSS pixels. | | `y` | `number` | Y coordinate of the start of the gesture in CSS pixels. | | `xDistance` (optional) | `number` | The distance to scroll along the X axis (positive to scroll left). | | `yDistance` (optional) | `number` | The distance to scroll along the Y axis (positive to scroll up). | | `xOverscroll` (optional) | `number` | The number of additional pixels to scroll back along the X axis, in addition to the given distance. | | `yOverscroll` (optional) | `number` | The number of additional pixels to scroll back along the Y axis, in addition to the given distance. | | `preventFling` (optional) | `boolean` | Prevent fling (default: true). | | `speed` (optional) | `integer` | Swipe speed in pixels per second (default: 800). | | `gestureSourceType` (optional) | `GestureSourceType` | Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type). | | `repeatCount` (optional) | `integer` | The number of times to repeat the gesture (default: 0). | | `repeatDelayMs` (optional) | `integer` | The number of milliseconds delay between each repeat. (default: 250). | | `interactionMarkerName` (optional) | `string` | The name of the interaction markers to generate, if not empty (default: ""). | #### `Input.synthesizeTapGesture` Experimental Synthesizes a tap gesture over a time period by issuing appropriate touch events. ###### Parameters | Name | Type | Description | |---|---|---| | `x` | `number` | X coordinate of the start of the gesture in CSS pixels. | | `y` | `number` | Y coordinate of the start of the gesture in CSS pixels. | | `duration` (optional) | `integer` | Duration between touchdown and touchup events in ms (default: 50). | | `tapCount` (optional) | `integer` | Number of times to perform the tap (e.g. 2 for double tap, default: 1). | | `gestureSourceType` (optional) | `GestureSourceType` | Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type). | ## Events #### `Input.dragIntercepted` Experimental Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to restore normal drag and drop behavior. ###### Parameters | Name | Type | Description | |---|---|---| | `data` | `DragData` | | ## Types #### `TouchPoint` (object) ###### Properties | Name | Type | Description | |---|---|---| | `x` | `number` | X coordinate of the event relative to the main frame's viewport in CSS pixels. | | `y` | `number` | Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. | | `radiusX` (optional) | `number` | X radius of the touch area (default: 1.0). | | `radiusY` (optional) | `number` | Y radius of the touch area (default: 1.0). | | `rotationAngle` (optional) | `number` | Rotation angle (default: 0.0). | | `force` (optional) | `number` | Force (default: 1.0). | | `tangentialPressure` (optional) Experimental | `number` | The normalized tangential pressure, which has a range of \[-1,1\] (default: 0). | | `tiltX` (optional) | `number` | The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range \[-90,90\], a positive tiltX is to the right (default: 0) | | `tiltY` (optional) | `number` | The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range \[-90,90\], a positive tiltY is towards the user (default: 0). | | `twist` (optional) Experimental | `integer` | The clockwise rotation of a pen stylus around its own major axis, in degrees in the range \[0,359\] (default: 0). | | `id` (optional) | `number` | Identifier used to track touch sources between events, must be unique within an event. | #### `GestureSourceType` (string) Experimental ###### Allowed Values - `default` - `touch` - `mouse` #### `MouseButton` (string) ###### Allowed Values - `none` - `left` - `middle` - `right` - `back` - `forward` #### `TimeSinceEpoch` (number) UTC time in seconds, counted from January 1, 1970. #### `DragDataItem` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `mimeType` | `string` | Mime type of the dragged data. | | `data` | `string` | Depending of the value of `mimeType`, it contains the dragged link, text, HTML markup or any other data. | | `title` (optional) | `string` | Title associated with a link. Only valid when `mimeType` == "text/uri-list". | | `baseURL` (optional) | `string` | Stores the base URL for the contained markup. Only valid when `mimeType` == "text/html". | #### `DragData` (object) Experimental ###### Properties | Name | Type | Description | |---|---|---| | `items` | `array<DragDataItem>` | | | `files` (optional) | `array<string>` | List of filenames that should be included when dropping | | `dragOperationsMask` | `integer` | Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16 |