# 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. ServiceWorker
 
  # ServiceWorker

 Experimental 

**Dependencies:** [Target](https://scrapfly.io/docs/cloud-browser-api/cdp-reference/Target)

 - [Commands (12)](#commands)
- [Events (3)](#events)
- [Types (6)](#types)
 
   

No symbols match your filter.

## Commands

#### `ServiceWorker.deliverPushMessage`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `origin` | `string` |  |
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `data` | `string` |  |

 

 

 

#### `ServiceWorker.disable`

 

 

 

#### `ServiceWorker.dispatchSyncEvent`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `origin` | `string` |  |
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `tag` | `string` |  |
| `lastChance` | `boolean` |  |

 

 

 

#### `ServiceWorker.dispatchPeriodicSyncEvent`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `origin` | `string` |  |
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `tag` | `string` |  |

 

 

 

#### `ServiceWorker.enable`

 

 

 

#### `ServiceWorker.setForceUpdateOnPageLoad`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `forceUpdateOnPageLoad` | `boolean` |  |

 

 

 

#### `ServiceWorker.skipWaiting`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `scopeURL` | `string` |  |

 

 

 

#### `ServiceWorker.startWorker`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `scopeURL` | `string` |  |

 

 

 

#### `ServiceWorker.stopAllWorkers`

 

 

 

#### `ServiceWorker.stopWorker`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `versionId` | `string` |  |

 

 

 

#### `ServiceWorker.unregister`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `scopeURL` | `string` |  |

 

 

 

#### `ServiceWorker.updateRegistration`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `scopeURL` | `string` |  |

 

 

 

 

## Events

#### `ServiceWorker.workerErrorReported`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `errorMessage` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-ServiceWorkerErrorMessage">ServiceWorkerErrorMessage</a>` |  |

 

 

 

#### `ServiceWorker.workerRegistrationUpdated`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `registrations` | `array<<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-ServiceWorkerRegistration">ServiceWorkerRegistration</a>>` |  |

 

 

 

#### `ServiceWorker.workerVersionUpdated`

 

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `versions` | `array<<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-ServiceWorkerVersion">ServiceWorkerVersion</a>>` |  |

 

 

 

 

## Types

#### `RegistrationID`

 (string) 

 

 

#### `ServiceWorkerRegistration`

 (object) 

ServiceWorker registration.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `scopeURL` | `string` |  |
| `isDeleted` | `boolean` |  |

 

 

 

#### `ServiceWorkerVersionRunningStatus`

 (string) 

###### Allowed Values

- `stopped`
- `starting`
- `running`
- `stopping`
 
 

 

#### `ServiceWorkerVersionStatus`

 (string) 

###### Allowed Values

- `new`
- `installing`
- `installed`
- `activating`
- `activated`
- `redundant`
 
 

 

#### `ServiceWorkerVersion`

 (object) 

ServiceWorker version.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `versionId` | `string` |  |
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `scriptURL` | `string` |  |
| `runningStatus` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-ServiceWorkerVersionRunningStatus">ServiceWorkerVersionRunningStatus</a>` |  |
| `status` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-ServiceWorkerVersionStatus">ServiceWorkerVersionStatus</a>` |  |
| `scriptLastModified`  (optional) | `number` | The Last-Modified header value of the main script. |
| `scriptResponseTime`  (optional) | `number` | The time at which the response headers of the main script were received from the server. For cached script it is the last time the cache entry was validated. |
| `controlledClients`  (optional) | `array<<a href="/docs/cloud-browser-api/cdp-reference/Target#type-TargetID">Target.TargetID</a>>` |  |
| `targetId`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Target#type-TargetID">Target.TargetID</a>` |  |
| `routerRules`  (optional) | `string` |  |

 

 

 

#### `ServiceWorkerErrorMessage`

 (object) 

ServiceWorker error message.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `errorMessage` | `string` |  |
| `registrationId` | `<a href="/docs/cloud-browser-api/cdp-reference/ServiceWorker#type-RegistrationID">RegistrationID</a>` |  |
| `versionId` | `string` |  |
| `sourceURL` | `string` |  |
| `lineNumber` | `integer` |  |
| `columnNumber` | `integer` |  |