Scrape Do connects to a Nagent workspace with an API key. Once it is connected, agents can call 16 Scrape Do actions, such as "Create Async Scraping Job", "Get Account Information" and "Get Amazon Product Offers". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Scrape Do, with input parameters and output schema.
SCRAPE_DO_CANCEL_ASYNC_JOBTool to cancel an asynchronous scraping job. Use when you need to stop processing of pending tasks in a job. Completed tasks remain available.
Input parameters
Authentication token for Scrape.do API
Unique identifier of the job to cancel
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_CREATE_ASYNC_JOBTool to create an asynchronous scraping job with specified targets and options. Use when you need to scrape multiple URLs in parallel without waiting for results. Returns a job ID immediately for polling results later via the get job status action.
Input parameters
HTTP request body for POST/PUT/PATCH requests
Use residential/mobile proxy networks (default: false)
Device types for scraping emulation.
HTTP methods for async scraping requests.
Output format for scraped content.
Options for headless browser rendering.
Country code for geo-targeting (e.g., 'us', 'gb', 'de')
Custom HTTP headers to send with requests
Array of target URLs to scrape. Each URL will be processed asynchronously.
Total request timeout in milliseconds (default: 60000)
Sticky session ID to reuse same IP address across requests
Cookies to include with the request
Webhook URL to send results to when job completes
Disable automatic retry mechanism (default: false)
Retry timeout per request in milliseconds (default: 15000)
Use only provided headers, discard default headers (default: false)
Additional headers to send with webhook notification
Regional code for more specific geo-targeting
Disable following HTTP redirects (default: false)
Return raw target website response without processing (default: false)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_ACCOUNT_INFORetrieves account information and usage statistics from Scrape.do. This action makes a GET request to the Scrape.do info endpoint to fetch: - Subscription status - Concurrent request limits and usage - Monthly request limits and remaining requests - Real-time usage statistics Rate limit: Maximum 10 requests per minute. Use remaining request counts to monitor credits proactively, as different scraping operations (e.g., rendered-page requests) consume varying credit amounts and exhaustion mid-run causes failures.
Input parameters
Authentication token for Scrape.do API
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_AMAZON_OFFERSGet all seller offers for any Amazon product. Retrieves every seller listing including pricing, shipping costs, seller information, and Buy Box status in structured JSON format. Use when you need to compare prices across multiple sellers or find the best deal for a specific product.
Input parameters
Amazon Standard Identification Number (10-character product ID)
Country code for Amazon marketplace (e.g., us, gb, de, jp, fr, es, it, ca)
Postal/ZIP code formatted according to country requirements
Enable residential/mobile proxies for higher success rates. Costs 10x credits
When true, includes the full raw HTML alongside structured JSON
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_AMAZON_PRODUCTExtract structured product data from Amazon product detail pages (PDP). Returns comprehensive product information including title, pricing, ratings, images, best seller rankings, and technical specifications in JSON format.
Input parameters
Amazon Standard Identification Number (10-character product ID)
Country code (e.g., us, gb, de, jp, fr, ca)
Postal code formatted according to country requirements
Language code in ISO 639-1 format (e.g., EN, DE, FR)
Enable residential/mobile proxies for higher success rates. Costs 10x credits
When true, includes the full raw HTML alongside structured JSON
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_AMAZON_RAW_HTMLTool to get raw HTML from any Amazon page with ZIP code geo-targeting. Use when you need complete unprocessed HTML source from Amazon URLs with location-based targeting. Ideal for scraping pages not covered by other structured endpoints.
Input parameters
Full Amazon URL to scrape (e.g., https://www.amazon.com/dp/B08N5WRWNW)
Enable residential/mobile proxies for higher success rates. Costs 10x credits. Default is false.
Output format - must be 'html' for raw HTML content
Country code for geo-targeting (e.g., us, gb, de, jp)
Request timeout in milliseconds
Postal code formatted according to country requirements (e.g., 10001 for US, SW1A 1AA for UK)
Language code in ISO 639-1 format (e.g., EN, DE, FR, ES)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_ASYNC_ACCOUNT_INFOTool to get account information for the Async API including concurrency limits and usage statistics. Use when you need to check available concurrency slots, active jobs, or remaining credits for Async API operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_ASYNC_JOBTool to retrieve details and status of a specific asynchronous scraping job. Use when you need to check the progress, status, or results of a previously created async job. Returns job metadata including creation time, completion time, task counts, and detailed task list.
Input parameters
Unique identifier of the job to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_ASYNC_TASKTool to retrieve the result of a specific task within an asynchronous job. Returns the scraped content for that particular URL. Use when you need to check the status and result of a previously submitted async scraping task.
Input parameters
Authentication token for Scrape.do API
Unique identifier of the job
Unique identifier of the task within the job
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_GET_PAGEA tool to scrape web pages using scrape.do's API service. Makes a basic GET request to fetch webpage content while handling anti-bot protections and proxy rotation automatically. Does not execute JavaScript by default — pages requiring client-side rendering (SPAs, dynamically loaded content) will return incomplete HTML; use SCRAPE_DO_GET_RENDER_PAGE or set render=true for those cases.
Input parameters
Target web page URL to scrape
Use residential & mobile proxy networks
Browser viewport width (requires render=true)
Specify device type (desktop, mobile, tablet)
Browser viewport height (requires render=true)
Output format (raw or markdown)
Enable headless browser rendering Use for JS-heavy pages, SPAs, or sites with anti-bot JS challenges. Increase `timeout` when enabling to ensure full page load before cutoff.
Maximum request timeout in ms (5000-120000)
Choose country for target web page (e.g. 'us', 'gb')
Return network requests in JSON format
Set cookies for target web page
Add/modify headers
Maximum retry timeout in ms (5000-55000)
Handle all request headers
Block CSS and image sources
Disable request redirection
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_LIST_ASYNC_JOBSTool to list all asynchronous scraping jobs. Returns paginated list of jobs with their status and metadata. Use when you need to retrieve job history or monitor job statuses. Supports pagination with up to 100 jobs per page.
Input parameters
Page number for pagination (default: 1, minimum: 1)
Number of jobs per page (default: 10, maximum: 100)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_PROXY_MODEThis tool implements the Proxy Mode functionality of scrape.do, which allows routing requests through their proxy server. It provides an alternative way to access web scraping capabilities by handling complex JavaScript-rendered pages, geolocation-based routing, device simulation, and built-in anti-bot and retry mechanisms.
Input parameters
The target URL to scrape
Device type to simulate (desktop, mobile, tablet)
Enable/disable JavaScript rendering
Geographic location for the request (e.g., 'us', 'uk')
Whether to forward custom headers to the target website
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_SCRAPE_URL_POSTTool to scrape web pages using POST method via scrape.do API. Use when you need to send POST requests to target websites with custom request body data. Supports all parameters from GET endpoint plus request body customization for POST/PUT/PATCH methods.
Input parameters
Target web page URL to scrape with POST request
HTTP request body for POST request. Can be JSON string, form data, or plain text
Enable residential/mobile proxies. Costs 10x credits
Device types for scraping emulation.
Enable JavaScript rendering with headless browser
Country code for geo-targeting (e.g. 'us', 'gb', 'de')
Total request timeout in milliseconds (5000-120000)
Sticky session ID to reuse same IP address across multiple requests
Cookies to include with the request (format: key1=value1; key2=value2)
Enable sending custom headers with the request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_SEARCH_AMAZONTool to search Amazon and scrape product listings with structured results. Performs keyword searches and returns structured product data including titles, prices, ratings, Prime status, sponsored flags, and position rankings in JSON format. Use when you need to search for products on Amazon marketplace or gather product information from search results.
Input parameters
Page number for pagination (default: 1)
Enable residential/mobile proxies for higher success rates. Costs 10x credits (default: false)
Country code for Amazon marketplace (e.g., us, gb, de, jp, ca, fr, it, es, in)
Search query term (will be URL-encoded automatically)
Postal/ZIP code formatted according to country requirements (e.g., 10001 for US, SW1A 1AA for UK)
Language code in ISO 639-1 format (e.g., EN, DE, FR, ES)
When true, includes the full raw HTML alongside structured JSON (default: false)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_SET_BLOCK_URLSThis tool allows users to block specific URLs during the scraping process. It's particularly useful for blocking unwanted resources like analytics scripts, advertisements, or any other URLs that might interfere with the scraping process or slow it down. It provides granular control by allowing users to specify URL patterns to block, thereby improving scraping performance and maintaining privacy.
Input parameters
List of URL patterns to block during scraping. Can be full URLs or patterns.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SCRAPE_DO_SET_REGIONAL_GEO_CODEThis tool allows users to set a broader geographical targeting by specifying a region code instead of a specific country code. This is useful when you want to scrape content from an entire region rather than a specific country. Note that this feature requires super mode to be enabled and is only available for Business Plan or higher subscriptions.
Input parameters
The target URL to scrape with the specified regional geo code
The region code to target for scraping requests
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 16 Scrape Do actions on Nagent, including "Create Async Scraping Job", "Get Account Information" and "Get Amazon Product Offers". Create Async Scraping Job: Create an asynchronous scraping job with specified targets and options. Each action is listed on this page with its input parameters and its output.
Scrape Do connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Async Scraping Job takes 1 required input: Targets. It also takes 19 optional inputs: Body, Super, Device, Method, Output, Render, GeoCode, Headers, Timeout, SessionID, SetCookies, WebhookURL, DisableRetry, RetryTimeout, ForwardHeaders, WebhookHeaders, RegionalGeoCode, DisableRedirection and TransparentResponse. It returns data, error and successful.