Actions
The integration exposes the following actions, grouped by category.
API
Extract Data From URL - Extract data from any URL through ScraperAPI's main endpoint. Returns HTML, Markdown, plain text, or parsed JSON depending on the options you choose. Handles proxies, browser rendering, and CAPTCHAs automatically.
URL
REQUIRED
The target URL to scrape (e.g. https://example.com).
Render JavaScript
OPTIONAL
Enable JavaScript rendering for pages that load content dynamically. Turn on only when needed, as it increases processing time.
Country Code
OPTIONAL
Two-letter ISO country code (us, eu, de) for geo-targeted scraping.
Device Type
OPTIONAL
Choose the device User Agent to scrape as: Desktop (default) or Mobile (mobile device).
Premium Proxies
OPTIONAL
Use premium residential proxies for higher success rates. Cannot be combined with Ultra Premium.
Ultra Premium
OPTIONAL
Activate advanced bypass for the most difficult, heavily protected sites. Cannot be combined with Premium.
Output Format
OPTIONAL
Response format. Valid options: markdown, text. For structured-data responses: json, csv, markdown, text.
Auto Parse
OPTIONAL
Enable auto-parsing for supported sites. Returns parsed JSON. Does not increase request cost.
Structured Data
Get Structured Data - Get clean, parsed JSON from a list of supported categories. Pick a Category, then an Operation. Operation-specific input fields (such as ASIN or Query) load dynamically once you make those selections.
Category
REQUIRED
The source category to pull structured data from (see the table below).
Operation
REQUIRED
The specific operation within the chosen category. Available operations depend on the selected category.
Dynamic fields
-
Each operation loads its own input fields (e.g. asin + tld for Amazon → Product details, or a search term / location for other operations) after Category and Operation are selected.
Supported categories and operations:
Amazon
Product Details, Search and Offers.
Search, Jobs, News, Shopping and Maps Search.
eBay
Search and Product Details.
Walmart
Search, Category Browse, Product Details and Reviews.
Redfin
Listings For Sale, Listings For Rent, Search and Agent Profile.
Crawler
Create Crawler Job - Start a one-off recursive crawl from a starting URL, following links and streaming page results to a webhook you control.
Start URL
REQUIRED
The starting URL the crawl begins with.
URL Regex (Include)
REQUIRED
A regular expression. Only URLs matching it will be crawled.
Callback Webhook URL
REQUIRED
The webhook endpoint that crawled page results are streamed to as they are processed.
Max Depth
OPTIONAL
How deep the crawl is allowed to follow from the start URL.
Crawl Budget
OPTIONAL
The maximum number of API Credits the crawl is allowed to use.
URL Regex (Exclude)
OPTIONAL
A regular expression for URLs to skip during the crawl.
Render JavaScript
OPTIONAL
Enable JavaScript rendering for pages that load content dynamically. Turn on only when needed, as it increases processing time.
Country Code
OPTIONAL
Two-letter ISO country code (us, eu, de) for geo-targeted scraping.
Device Type
OPTIONAL
Choose the device User Agent to scrape as: Desktop (default) or Mobile (mobile device).
Premium Proxies
OPTIONAL
Use premium residential proxies for higher success rates. Cannot be combined with Ultra Premium.
Ultra Premium
OPTIONAL
Activate advanced bypass for the most difficult, heavily protected sites. Cannot be combined with Premium.
Output Format
OPTIONAL
Response format. Valid options: markdown, text. For structured-data responses: json, csv, markdown, text.
Auto Parse
OPTIONAL
Enable auto-parsing for supported sites. Returns parsed JSON. Does not increase request cost.
Get Crawler Job Status - Retrieve the current status and counters (e.g. pages crawled) for a running or completed crawler job.
Job ID
REQUIRED
The ID returned by Create Crawler Job.
Cancel Crawler Job - Cancel an active crawler job by its job ID.
Job ID
REQUIRED
The ID of the crawler job to cancel.
Last updated