# 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. Preload
# Preload
Experimental
- [Commands (2)](#commands)
- [Events (6)](#events)
- [Types (12)](#types)
No symbols match your filter.
## Commands
#### `Preload.enable`
#### `Preload.disable`
## Events
#### `Preload.ruleSetUpdated`
Upsert. Currently, it is only emitted when a rule set added.
###### Parameters
| Name | Type | Description |
|---|---|---|
| `ruleSet` | `RuleSet` | |
#### `Preload.ruleSetRemoved`
###### Parameters
| Name | Type | Description |
|---|---|---|
| `id` | `RuleSetId` | |
#### `Preload.preloadEnabledStateUpdated`
Fired when a preload enabled state is updated.
###### Parameters
| Name | Type | Description |
|---|---|---|
| `disabledByPreference` | `boolean` | |
| `disabledByDataSaver` | `boolean` | |
| `disabledByBatterySaver` | `boolean` | |
| `disabledByHoldbackPrefetchSpeculationRules` | `boolean` | |
| `disabledByHoldbackPrerenderSpeculationRules` | `boolean` | |
#### `Preload.prefetchStatusUpdated`
Fired when a prefetch attempt is updated.
###### Parameters
| Name | Type | Description |
|---|---|---|
| `key` | `PreloadingAttemptKey` | |
| `pipelineId` | `PreloadPipelineId` | |
| `initiatingFrameId` | `Page.FrameId` | The frame id of the frame initiating prefetch. |
| `prefetchUrl` | `string` | |
| `status` | `PreloadingStatus` | |
| `prefetchStatus` | `PrefetchStatus` | |
| `requestId` | `Network.RequestId` | |
#### `Preload.prerenderStatusUpdated`
Fired when a prerender attempt is updated.
###### Parameters
| Name | Type | Description |
|---|---|---|
| `key` | `PreloadingAttemptKey` | |
| `pipelineId` | `PreloadPipelineId` | |
| `status` | `PreloadingStatus` | |
| `prerenderStatus` (optional) | `PrerenderFinalStatus` | |
| `disallowedMojoInterface` (optional) | `string` | This is used to give users more information about the name of Mojo interface that is incompatible with prerender and has caused the cancellation of the attempt. |
| `mismatchedHeaders` (optional) | `array<PrerenderMismatchedHeaders>` | |
#### `Preload.preloadingAttemptSourcesUpdated`
Send a list of sources for all preloading attempts in a document.
###### Parameters
| Name | Type | Description |
|---|---|---|
| `loaderId` | `Network.LoaderId` | |
| `preloadingAttemptSources` | `array<PreloadingAttemptSource>` | |
## Types
#### `RuleSetId`
(string)
Unique id
#### `RuleSet`
(object)
Corresponds to SpeculationRuleSet
###### Properties
| Name | Type | Description |
|---|---|---|
| `id` | `RuleSetId` | |
| `loaderId` | `Network.LoaderId` | Identifies a document which the rule set is associated with. |
| `sourceText` | `string` | Source text of JSON representing the rule set. If it comes from `<script>` tag, it is the textContent of the node. Note that it is a JSON for valid case. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html - https://github.com/WICG/nav-speculation/blob/main/triggers.md |
| `backendNodeId` (optional) | `DOM.BackendNodeId` | A speculation rule set is either added through an inline `<script>` tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant `<script>` tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header |
| `url` (optional) | `string` | |
| `requestId` (optional) | `Network.RequestId` | |
| `errorType` (optional) | `RuleSetErrorType` | Error information `errorMessage` is null iff `errorType` is null. |
| `errorMessage` (optional) Deprecated | `string` | TODO(https://crbug.com/1425354): Replace this property with structured error. |
| `tag` (optional) | `string` | For more details, see: https://github.com/WICG/nav-speculation/blob/main/speculation-rules-tags.md |
#### `RuleSetErrorType`
(string)
###### Allowed Values
- `SourceIsNotJsonObject`
- `InvalidRulesSkipped`
- `InvalidRulesetLevelTag`
#### `SpeculationAction`
(string)
The type of preloading attempted. It corresponds to
mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
isn't being used by clients).
###### Allowed Values
- `Prefetch`
- `Prerender`
- `PrerenderUntilScript`
#### `SpeculationTargetHint`
(string)
Corresponds to mojom::SpeculationTargetHint.
See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
###### Allowed Values
- `Blank`
- `Self`
#### `PreloadingAttemptKey`
(object)
A key that identifies a preloading attempt.
The url used is the url specified by the trigger (i.e. the initial URL), and
not the final url that is navigated to. For example, prerendering allows
same-origin main frame navigations during the attempt, but the attempt is
still keyed with the initial URL.
###### Properties
| Name | Type | Description |
|---|---|---|
| `loaderId` | `Network.LoaderId` | |
| `action` | `SpeculationAction` | |
| `url` | `string` | |
| `targetHint` (optional) | `SpeculationTargetHint` | |
#### `PreloadingAttemptSource`
(object)
Lists sources for a preloading attempt, specifically the ids of rule sets
that had a speculation rule that triggered the attempt, and the
BackendNodeIds of <a href> or <area href> elements that triggered the
attempt (in the case of attempts triggered by a document rule). It is
possible for multiple rule sets and links to trigger a single attempt.
###### Properties
| Name | Type | Description |
|---|---|---|
| `key` | `PreloadingAttemptKey` | |
| `ruleSetIds` | `array<RuleSetId>` | |
| `nodeIds` | `array<DOM.BackendNodeId>` | |
#### `PreloadPipelineId`
(string)
Chrome manages different types of preloads together using a
concept of preloading pipeline. For example, if a site uses a
SpeculationRules for prerender, Chrome first starts a prefetch and
then upgrades it to prerender.
CDP events for them are emitted separately but they share
`PreloadPipelineId`.
#### `PrerenderFinalStatus`
(string)
List of FinalStatus reasons for Prerender2.
###### Allowed Values
- `Activated`
- `Destroyed`
- `LowEndDevice`
- `InvalidSchemeRedirect`
- `InvalidSchemeNavigation`
- `NavigationRequestBlockedByCsp`
- `MojoBinderPolicy`
- `RendererProcessCrashed`
- `RendererProcessKilled`
- `Download`
- `TriggerDestroyed`
- `NavigationNotCommitted`
- `NavigationBadHttpStatus`
- `ClientCertRequested`
- `NavigationRequestNetworkError`
- `CancelAllHostsForTesting`
- `DidFailLoad`
- `Stop`
- `SslCertificateError`
- `LoginAuthRequested`
- `UaChangeRequiresReload`
- `BlockedByClient`
- `AudioOutputDeviceRequested`
- `MixedContent`
- `TriggerBackgrounded`
- `MemoryLimitExceeded`
- `DataSaverEnabled`
- `TriggerUrlHasEffectiveUrl`
- `ActivatedBeforeStarted`
- `InactivePageRestriction`
- `StartFailed`
- `TimeoutBackgrounded`
- `CrossSiteRedirectInInitialNavigation`
- `CrossSiteNavigationInInitialNavigation`
- `SameSiteCrossOriginRedirectNotOptInInInitialNavigation`
- `SameSiteCrossOriginNavigationNotOptInInInitialNavigation`
- `ActivationNavigationParameterMismatch`
- `ActivatedInBackground`
- `EmbedderHostDisallowed`
- `ActivationNavigationDestroyedBeforeSuccess`
- `TabClosedByUserGesture`
- `TabClosedWithoutUserGesture`
- `PrimaryMainFrameRendererProcessCrashed`
- `PrimaryMainFrameRendererProcessKilled`
- `ActivationFramePolicyNotCompatible`
- `PreloadingDisabled`
- `BatterySaverEnabled`
- `ActivatedDuringMainFrameNavigation`
- `PreloadingUnsupportedByWebContents`
- `CrossSiteRedirectInMainFrameNavigation`
- `CrossSiteNavigationInMainFrameNavigation`
- `SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation`
- `SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation`
- `MemoryPressureOnTrigger`
- `MemoryPressureAfterTriggered`
- `PrerenderingDisabledByDevTools`
- `SpeculationRuleRemoved`
- `ActivatedWithAuxiliaryBrowsingContexts`
- `MaxNumOfRunningEagerPrerendersExceeded`
- `MaxNumOfRunningNonEagerPrerendersExceeded`
- `MaxNumOfRunningEmbedderPrerendersExceeded`
- `PrerenderingUrlHasEffectiveUrl`
- `RedirectedPrerenderingUrlHasEffectiveUrl`
- `ActivationUrlHasEffectiveUrl`
- `JavaScriptInterfaceAdded`
- `JavaScriptInterfaceRemoved`
- `AllPrerenderingCanceled`
- `WindowClosed`
- `SlowNetwork`
- `OtherPrerenderedPageActivated`
- `V8OptimizerDisabled`
- `PrerenderFailedDuringPrefetch`
- `BrowsingDataRemoved`
- `PrerenderHostReused`
#### `PreloadingStatus`
(string)
Preloading status values, see also PreloadingTriggeringOutcome. This
status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
###### Allowed Values
- `Pending`
- `Running`
- `Ready`
- `Success`
- `Failure`
- `NotSupported`
#### `PrefetchStatus`
(string)
TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
filter out the ones that aren't necessary to the developers.
###### Allowed Values
- `PrefetchAllowed`
- `PrefetchFailedIneligibleRedirect`
- `PrefetchFailedInvalidRedirect`
- `PrefetchFailedMIMENotSupported`
- `PrefetchFailedNetError`
- `PrefetchFailedNon2XX`
- `PrefetchEvictedAfterBrowsingDataRemoved`
- `PrefetchEvictedAfterCandidateRemoved`
- `PrefetchEvictedForNewerPrefetch`
- `PrefetchHeldback`
- `PrefetchIneligibleRetryAfter`
- `PrefetchIsPrivacyDecoy`
- `PrefetchIsStale`
- `PrefetchNotEligibleBrowserContextOffTheRecord`
- `PrefetchNotEligibleDataSaverEnabled`
- `PrefetchNotEligibleExistingProxy`
- `PrefetchNotEligibleHostIsNonUnique`
- `PrefetchNotEligibleNonDefaultStoragePartition`
- `PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy`
- `PrefetchNotEligibleSchemeIsNotHttps`
- `PrefetchNotEligibleUserHasCookies`
- `PrefetchNotEligibleUserHasServiceWorker`
- `PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler`
- `PrefetchNotEligibleRedirectFromServiceWorker`
- `PrefetchNotEligibleRedirectToServiceWorker`
- `PrefetchNotEligibleBatterySaverEnabled`
- `PrefetchNotEligiblePreloadingDisabled`
- `PrefetchNotFinishedInTime`
- `PrefetchNotStarted`
- `PrefetchNotUsedCookiesChanged`
- `PrefetchProxyNotAvailable`
- `PrefetchResponseUsed`
- `PrefetchSuccessfulButNotUsed`
- `PrefetchNotUsedProbeFailed`
#### `PrerenderMismatchedHeaders`
(object)
Information of headers to be displayed when the header mismatch occurred.
###### Properties
| Name | Type | Description |
|---|---|---|
| `headerName` | `string` | |
| `initialValue` (optional) | `string` | |
| `activationValue` (optional) | `string` | |