> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Scrapingbee

> ScrapingBee is a web scraping API that handles headless browsers and proxy rotation, allowing developers to extract HTML from any website in a single API call.

![Scrapingbee logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/scrapingbee.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=7a6a5ceeaf166a65f96f3f6129ae1542)

* **Category:** web scraping & browser
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 5
* **Triggers:** 0
* **Slug:** `SCRAPINGBEE`
* **Version:** 20261101\_00

## Tools

> [accordion] ScrapingBee Data Extraction
>
> **Slug:** `SCRAPINGBEE_DATA_EXTRACTION`
>
> Extract structured data from a webpage using CSS or XPath selectors via ScrapingBee's extract\_rules feature. Requires an explicit ScrapingBee API key in the request.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The webpage URL to extract data from.
>
> **wait** `integer`
>
> Seconds to wait before extraction (for dynamic content).
>
> **device** `string ("desktop" | "mobile")`
>
> Emulate device type (desktop or mobile).
>
> **api\_key** `string` *required*
>
> Your ScrapingBee API key.
>
> **extractor** `object` *required*
>
> JSON object defining fields to extract and their CSS/XPath selectors. For nested selectors, use object with 'selector' and optional 'type' keys. Misaligned or invalid selectors silently drop fields with no error — verify each selector matches the target DOM before large-scale use.
>
> **javascript** `boolean`
>
> Whether to render JavaScript before extraction.
>
> **country\_code** `string`
>
> Two-letter country code for proxy geolocation (e.g., 'us', 'de').
>
> **premium\_proxy** `boolean`
>
> Use premium proxy for higher reliability.
>
> **block\_resources** `boolean`
>
> Block images, CSS, and resources to speed up extraction.
>
> **forward\_headers** `object`
>
> Custom HTTP headers to forward to the target website. Provide as a dict, e.g., \{'Accept-Language': 'en-US'}. Headers will be prefixed with 'Spb-' and forwarded to the target.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ScrapingBee HTML Fetch
>
> **Slug:** `SCRAPINGBEE_HTML_FETCH`
>
> Fetch page content or a screenshot through ScrapingBee's HTML API, with optional JavaScript rendering, proxy and resource controls. For screenshot requests, the returned HTML field may be empty.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL to scrape.
>
> **wait** `integer`
>
> Milliseconds to wait before returning content.
>
> **retry** `integer`
>
> Number of retries on request failure.
>
> **device** `string ("desktop" | "mobile")`
>
> Device type to emulate ('desktop' or 'mobile').
>
> **cookies** `string`
>
> Cookies to send in requests (HTTP header string).
>
> **wait\_for** `string`
>
> CSS selector to wait for before returning content.
>
> **block\_ads** `boolean`
>
> Block ads and tracking scripts.
>
> **render\_js** `boolean`
>
> Render JavaScript before returning HTML. Required for client-side rendered pages where dynamic data is absent in raw HTML.
>
> **js\_snippet** `string`
>
> JavaScript snippet to execute before returning content.
>
> **screenshot** `boolean`
>
> Return screenshot as base64-encoded PNG.
>
> **js\_scenario** `string`
>
> JSON scenario for custom headless browser actions.
>
> **country\_code** `string`
>
> Two-letter country code for geolocation (e.g., 'us').
>
> **extract\_rules** `string`
>
> Extraction rules (CSS selector or JSONPath).
>
> **premium\_proxy** `boolean`
>
> Use premium proxy for scraping.
>
> **stealth\_proxy** `boolean`
>
> Use stealth (undetectable) proxy mode.
>
> **block\_resources** `boolean`
>
> Block images and CSS resources on the page to speed up scraping.
>
> **screenshot\_selector** `string`
>
> CSS selector of element to screenshot.
>
> **screenshot\_full\_page** `boolean`
>
> Capture full-page screenshot instead of only viewport.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ScrapingBee Proxy Mode
>
> **Slug:** `SCRAPINGBEE_SCRAPING_BEE_PROXY_MODE`
>
> Fetch web content through ScrapingBee's HTML API with optional JavaScript rendering, proxy selection, and resource blocking.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The target URL to scrape through ScrapingBee Proxy Mode.
>
> **cookies** `object`
>
> Cookies to send with the request as a key-value mapping.
>
> **headers** `object`
>
> Additional HTTP headers to forward to the target site. Each header will be prefixed with 'Spb-' and forwarded when forward\_headers is enabled.
>
> **timeout** `integer`
>
> Request timeout in milliseconds.
>
> **block\_ads** `boolean`
>
> Block ads and tracking scripts to speed up scraping.
>
> **render\_js** `boolean`
>
> Enable JavaScript rendering before returning content.
>
> **session\_id** `integer`
>
> Session identifier (integer) to keep the same IP for multiple requests. Use the same number to maintain consistent IP across requests.
>
> **js\_scenario** `string`
>
> Custom JavaScript scenario name for advanced interactions.
>
> **country\_code** `string ("us" | "de" | "fr" | "uk" | "ca" | "it" | "es")`
>
> Two-letter country code for geolocated proxy (e.g., 'us', 'fr').
>
> **premium\_proxy** `boolean`
>
> Use premium proxies for higher reliability.
>
> **stealth\_proxy** `boolean`
>
> Use stealth proxy mode for extra undetectability.
>
> **block\_resources** `boolean`
>
> Block images and CSS resources to speed up scraping. Only relevant when render\_js is enabled.
>
> **forward\_headers** `boolean`
>
> Forward original request headers to the target site.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ScrapingBee Stealth Proxy
>
> **Slug:** `SCRAPINGBEE_STEALTH_PROXY`
>
> Fetch web content through ScrapingBee with optional stealth proxy and JavaScript rendering for sites with anti-bot measures. Stealth proxy must be enabled explicitly.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The URL of the webpage to retrieve using stealth proxy.
>
> **wait** `integer`
>
> Wait time in milliseconds before returning the response.
>
> **device** `string ("desktop" | "mobile")`
>
> Device type to emulate during rendering. Options: 'desktop' or 'mobile'.
>
> **cookies** `string`
>
> Custom cookies in semicolon-separated format: 'name1=value1;name2=value2'.
>
> **js\_render** `boolean`
>
> Render JavaScript on the page before returning the response.
>
> **country\_code** `string`
>
> Two-letter country code for proxy geolocation (e.g., 'us', 'de').
>
> **extract\_rules** `string`
>
> Extraction rules in JSON string for structured data.
>
> **premium\_proxy** `boolean`
>
> Use premium proxies for higher reliability.
>
> **stealth\_proxy** `boolean`
>
> Enable stealth proxy mode. Use when the target site blocks bots.
>
> **block\_resources** `boolean`
>
> Block images, styles, and fonts for faster loads.
>
> **forward\_headers** `boolean`
>
> Forward original request headers from the browser.
>
> **return\_page\_source** `boolean`
>
> Return the raw page source instead of text.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ScrapingBee Usage Stats
>
> **Slug:** `SCRAPINGBEE_USAGE_STATS`
>
> Retrieve ScrapingBee account usage statistics, including credit usage, concurrency limits and current concurrency, and subscription renewal date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
