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

 Experimental 

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

 - [Commands (10)](#commands)
- [Events (4)](#events)
- [Types (5)](#types)
 
   

No symbols match your filter.

## Commands

#### `Animation.disable`

 

Disables animation domain notifications.

 

 

#### `Animation.enable`

 

Enables animation domain notifications.

 

 

#### `Animation.getCurrentTime`

 

Returns the current time of the an animation.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `id` | `string` | Id of animation. |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `currentTime` | `number` | Current time of the page. |

 

 

 

#### `Animation.getPlaybackRate`

 

Gets the playback rate of the document timeline.

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `playbackRate` | `number` | Playback rate for animations on page. |

 

 

 

#### `Animation.releaseAnimations`

 

Releases a set of animations to no longer be manipulated.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animations` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-string">string</a>>` | List of animation ids to seek. |

 

 

 

#### `Animation.resolveAnimation`

 

Gets the remote object of the Animation.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animationId` | `string` | Animation id. |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `remoteObject` | `<a href="/docs/cloud-browser-api/cdp-reference/Runtime#type-RemoteObject">Runtime.RemoteObject</a>` | Corresponding remote object. |

 

 

 

#### `Animation.seekAnimations`

 

Seek a set of animations to a particular time within each animation.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animations` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-string">string</a>>` | List of animation ids to seek. |
| `currentTime` | `number` | Set the current time of each animation. |

 

 

 

#### `Animation.setPaused`

 

Sets the paused state of a set of animations.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animations` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-string">string</a>>` | Animations to set the pause state of. |
| `paused` | `boolean` | Paused state to set to. |

 

 

 

#### `Animation.setPlaybackRate`

 

Sets the playback rate of the document timeline.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `playbackRate` | `number` | Playback rate for animations on page |

 

 

 

#### `Animation.setTiming`

 

Sets the timing of an animation node.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animationId` | `string` | Animation id. |
| `duration` | `number` | Duration of the animation. |
| `delay` | `number` | Delay of the animation. |

 

 

 

 

## Events

#### `Animation.animationCanceled`

 

Event for when an animation has been cancelled.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `id` | `string` | Id of the animation that was cancelled. |

 

 

 

#### `Animation.animationCreated`

 

Event for each animation that has been created.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `id` | `string` | Id of the animation that was created. |

 

 

 

#### `Animation.animationStarted`

 

Event for animation that has been started.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animation` | `<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-Animation">Animation</a>` | Animation that was started. |

 

 

 

#### `Animation.animationUpdated`

 

Event for animation that has been updated.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `animation` | `<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-Animation">Animation</a>` | Animation that was updated. |

 

 

 

 

## Types

#### `Animation`

 (object) 

Animation instance.

###### Properties

 | Name | Type | Description |
|---|---|---|
| `id` | `string` | `Animation`'s id. |
| `name` | `string` | `Animation`'s name. |
| `pausedState` | `boolean` | `Animation`'s internal paused state. |
| `playState` | `string` | `Animation`'s play state. |
| `playbackRate` | `number` | `Animation`'s playback rate. |
| `startTime` | `number` | `Animation`'s start time. Milliseconds for time based animations and percentage \[0 - 100\] for scroll driven animations (i.e. when viewOrScrollTimeline exists). |
| `currentTime` | `number` | `Animation`'s current time. |
| `type` | `string` | Animation type of `Animation`. |
| `source`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-AnimationEffect">AnimationEffect</a>` | `Animation`'s source animation node. |
| `cssId`  (optional) | `string` | A unique ID for `Animation` representing the sources that triggered this CSS animation/transition. |
| `viewOrScrollTimeline`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-ViewOrScrollTimeline">ViewOrScrollTimeline</a>` | View or scroll timeline |

 

 

 

#### `ViewOrScrollTimeline`

 (object) 

Timeline instance

###### Properties

 | Name | Type | Description |
|---|---|---|
| `sourceNodeId`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/DOM#type-BackendNodeId">DOM.BackendNodeId</a>` | Scroll container node |
| `startOffset`  (optional) | `number` | Represents the starting scroll position of the timeline as a length offset in pixels from scroll origin. |
| `endOffset`  (optional) | `number` | Represents the ending scroll position of the timeline as a length offset in pixels from scroll origin. |
| `subjectNodeId`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/DOM#type-BackendNodeId">DOM.BackendNodeId</a>` | The element whose principal box's visibility in the scrollport defined the progress of the timeline. Does not exist for animations with ScrollTimeline |
| `axis` | `<a href="/docs/cloud-browser-api/cdp-reference/DOM#type-ScrollOrientation">DOM.ScrollOrientation</a>` | Orientation of the scroll |

 

 

 

#### `AnimationEffect`

 (object) 

AnimationEffect instance

###### Properties

 | Name | Type | Description |
|---|---|---|
| `delay` | `number` | `AnimationEffect`'s delay. |
| `endDelay` | `number` | `AnimationEffect`'s end delay. |
| `iterationStart` | `number` | `AnimationEffect`'s iteration start. |
| `iterations`  (optional) | `number` | `AnimationEffect`'s iterations. Omitted if the value is infinite. |
| `duration` | `number` | `AnimationEffect`'s iteration duration. Milliseconds for time based animations and percentage \[0 - 100\] for scroll driven animations (i.e. when viewOrScrollTimeline exists). |
| `direction` | `string` | `AnimationEffect`'s playback direction. |
| `fill` | `string` | `AnimationEffect`'s fill mode. |
| `backendNodeId`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/DOM#type-BackendNodeId">DOM.BackendNodeId</a>` | `AnimationEffect`'s target node. |
| `keyframesRule`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-KeyframesRule">KeyframesRule</a>` | `AnimationEffect`'s keyframes. |
| `easing` | `string` | `AnimationEffect`'s timing function. |

 

 

 

#### `KeyframesRule`

 (object) 

Keyframes Rule

###### Properties

 | Name | Type | Description |
|---|---|---|
| `name`  (optional) | `string` | CSS keyframed animation's name. |
| `keyframes` | `array<<a href="/docs/cloud-browser-api/cdp-reference/Animation#type-KeyframeStyle">KeyframeStyle</a>>` | List of animation keyframes. |

 

 

 

#### `KeyframeStyle`

 (object) 

Keyframe Style

###### Properties

 | Name | Type | Description |
|---|---|---|
| `offset` | `string` | Keyframe's time offset. |
| `easing` | `string` | `AnimationEffect`'s timing function. |