Octopus Scraping icon

Octopus Scraping

Interact with Octopus Scraping for web scraping, screenshots, PDFs, and browser automation

Octopus Scraping

AI-generated

Summary

Send web scraping, page capture, extraction, or browser automation requests to an Octopus Scraping worker for each incoming item. Choose an action to capture screenshots or PDFs, extract content, crawl pages, interact with forms, run browser steps, monitor changes, or request health and IP information.

Inputs

  • action — Select the worker action; defaults to Screenshot. Available actions include scraping, Markdown, accessibility snapshots, links, AI JSON extraction, crawling, SEO, browser interactions, batch processing, health checks, and IP lookup.
  • url (required) — Target page URL for page-based actions. Not used for Health Check, IP Lookup, Batch, or Run Custom Steps.
  • ipAddress — For IP Lookup, optional IPv4 or IPv6 address. Blank omits the address, requesting the service's declared automatic public-IP detection.
  • fullPage — For Screenshot, capture the full page rather than just the viewport; defaults to true.
  • format — Screenshot image format: PNG (default) or JPEG.
  • viewportWidth — Screenshot viewport width in pixels; defaults to 1920. Also displayed for PDF, but not sent for that action.
  • viewportHeight — Screenshot viewport height in pixels; defaults to 1080. Also displayed for PDF, but not sent for that action.
  • clipRegion — Optional Screenshot crop region with x, y, width, and height.
  • pageFormat — PDF paper format: A4 (default), Legal, Letter, or Tabloid.
  • landscape — For PDF, request landscape orientation; defaults to false.
  • margin — Optional PDF top, bottom, left, and right margins expressed as strings such as 1cm.
  • selectors — For Scrape, add result keys and CSS selectors with text, HTML, outer HTML, attributes, all element data, or text-plus-attribute output. Custom attributes use Attribute Name. Entries missing a result key or selector are skipped.
  • waitUntil — Page loading condition for Scrape, Markdown, Snapshot, Links, and JSON Extraction: load (default), domcontentloaded, networkidle0, or networkidle2. Only nondefault values are sent.
  • waitForSelector — Optional CSS selector to wait for before Scrape or Markdown.
  • prompt — Optional natural language instructions for AI JSON Extraction.
  • schema — Optional JSON schema for AI JSON Extraction. Nonempty values other than the default {} are parsed as JSON before sending.
  • maxDepth — Maximum crawl depth; defaults to 2.
  • maxPages — Maximum pages to crawl; defaults to 10.
  • includePattern — Optional URL inclusion pattern for Crawl.
  • excludePattern — Optional URL exclusion pattern for Crawl.
  • selector — CSS selector of the element to click for Click.
  • waitFor — For Click, delay after clicking in milliseconds; defaults to 2000.
  • takeScreenshot — For Click, request a screenshot after clicking; defaults to false.
  • cookieOperation — Cookies operation; Get is the only available choice.
  • script — JavaScript function to execute in page context for Evaluate JavaScript; defaults to () => document.title.
  • waitBefore — For Evaluate JavaScript, optional positive delay before execution in milliseconds; defaults to 0.
  • urls — For Batch, comma-separated URLs. Each entry is trimmed; empty entries are not removed.
  • batchAction — Action applied to Batch URLs: Scrape (default), Markdown, or Screenshot.
  • parallel — Request parallel processing within Batch; defaults to false.
  • steps — Ordered Run Custom Steps collection: navigate to a URL, wait, click, type text, wait for a selector, take a screenshot, get page content, or scrape elements. Each step supplies its relevant URL, selector, duration, text, or extraction mode. A zero or missing wait duration becomes 1000 ms.
  • timeout — Execution timeout for Run Custom Steps, Crawl, and Batch in milliseconds; defaults to 30000. Also controls the HTTP request timeout, with 60000 ms used when the value is zero.
  • returnBinary — For successful Screenshot or PDF responses containing a result, decode the base64 result into an n8n binary file; defaults to false.
  • binaryProperty — Binary property name when Return Binary Data is enabled; defaults to data.
  • formFields — For Fill Form, add CSS selector and value pairs. Entries without a selector are skipped.
  • submitSelector — Optional submit-button CSS selector for Fill Form; blank omits submission.
  • formAfterWait — For Fill Form, positive delay after submission in milliseconds; defaults to 2000.
  • formScreenshot — For Fill Form, request a screenshot after submission; defaults to false.
  • scrollCount — Number of scrolls for Scroll; defaults to 5.
  • scrollDelay — Delay between scrolls in milliseconds; defaults to 2000.
  • scrollToTop — For Scroll, return to the top afterward; defaults to false.
  • scrollScreenshot — For Scroll, request a screenshot afterward; defaults to false.
  • loginUsername — Username or email to send for Login.
  • loginPassword — Password to send for Login.
  • usernameSelector — Login username-field CSS selector; defaults to input[type="email"].
  • passwordSelector — Login password-field CSS selector; defaults to input[type="password"].
  • loginSubmitSelector — Login submit-button CSS selector; defaults to button[type="submit"].
  • successSelector — Optional CSS selector indicating successful login.
  • loginScreenshot — For Login, request a screenshot afterward; defaults to false.
  • monitorTtl — Cache time-to-live for Monitor Changes in seconds; defaults to 3600.
  • includeContent — For Monitor Changes, request page content in the response; defaults to false.
  • waitForContentSelector — CSS selector to wait for in Wait for Content.
  • waitForContentWaitUntil — Loading condition for Wait for Content: load (default), domcontentloaded, networkidle0, or networkidle2. Only nondefault values are sent.
  • tableSelector — CSS selector for Extract Tables; defaults to table.
  • includeHeaders — For Extract Tables, include table headers; defaults to true.
  • extractType — Smart Extract content type: auto detection (default), article, product, recipe, or event.
  • webhookOptions — Optional webhook configuration for page-based actions: destination URL, POST/PUT/PATCH method (default POST), optional secret declared as an X-Webhook-Secret header, and whether to include the original request. Sent only when a webhook URL is provided.

Output shape

One output item per incoming item containing the worker's JSON response, or Screenshot/PDF metadata plus a binary file when binary conversion is enabled.

Worker response fields and action-specific result structures are passed through without normalization; their exact shapes are not defined in this source. Screenshot/PDF results remain base64 in the response by default. Binary conversion requires truthy success and result fields and replaces the response JSON with success, fileName, and mimeType. Incoming items are processed sequentially. With Continue On Fail enabled, caught errors return success: false and an error message; otherwise execution throws.

Links

Discussion