Scrape Website Text with WebScraping.AI API

Pipedream makes it easy to connect APIs for WebScraping.AI and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Scrape Website Text with the WebScraping.AI API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Scrape Website Text with the WebScraping.AI API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Scrape Website Text action
1. Connect your WebScraping.AI account
2. Configure Target URL
3. Optional- Configure Headers
4. Optional- Configure Timeout
5. Optional- Configure JS
6. Optional- Configure JS Timeout
7. Optional- Configure Wait For
8. Optional- Select a Proxy
9. Optional- Select a Country
10. Optional- Configure Custom Proxy
11. Optional- Select a Device
12. Optional- Configure Error on 404
13. Optional- Configure Error on Redirect
14. Optional- Configure JS Script
15. Optional- Select a Text Format
16. Optional- Configure Return Links
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Scrape Website Text with WebScraping.AI API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + WebScraping.AI

Try it

Scrape Website Text with WebScraping.AI API on New Submission from Typeform API

Typeform + WebScraping.AI

Try it

Scrape Website Text with WebScraping.AI API on New Submission (Instant) from Jotform API

Jotform + WebScraping.AI

Try it

Scrape Website Text with WebScraping.AI API on New Scheduled Tasks from Pipedream API

Pipedream + WebScraping.AI

Try it

Scrape Website Text with WebScraping.AI API on New Download Counts from npm API

npm + WebScraping.AI

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Scrape Website Text on WebScraping.AI

Description:Returns the visible text content of a webpage specified by the URL. [See the documentation](https://webscraping.ai/docs#tag/Text/operation/getText).

Version:0.0.1

Key:webscraping_ai-scrape-website-text

View on GitHub

Code#

import webscrapingAI from "../../webscraping_ai.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "webscraping_ai-scrape-website-text",
  name: "Scrape Website Text",
  description: "Returns the visible text content of a webpage specified by the URL. [See the documentation](https://webscraping.ai/docs#tag/Text/operation/getText).",
  version: "0.0.1",
  type: "action",
  props: {
    webscrapingAI,
    targetUrl: {
      propDefinition: [
        webscrapingAI,
        "targetUrl",
      ],
    },
    headers: {
      propDefinition: [
        webscrapingAI,
        "headers",
      ],
    },
    timeout: {
      propDefinition: [
        webscrapingAI,
        "timeout",
      ],
    },
    js: {
      propDefinition: [
        webscrapingAI,
        "js",
      ],
    },
    jsTimeout: {
      propDefinition: [
        webscrapingAI,
        "jsTimeout",
      ],
    },
    waitFor: {
      propDefinition: [
        webscrapingAI,
        "waitFor",
      ],
    },
    proxy: {
      propDefinition: [
        webscrapingAI,
        "proxy",
      ],
    },
    country: {
      propDefinition: [
        webscrapingAI,
        "country",
      ],
    },
    customProxy: {
      propDefinition: [
        webscrapingAI,
        "customProxy",
      ],
    },
    device: {
      propDefinition: [
        webscrapingAI,
        "device",
      ],
    },
    errorOn404: {
      propDefinition: [
        webscrapingAI,
        "errorOn404",
      ],
    },
    errorOnRedirect: {
      propDefinition: [
        webscrapingAI,
        "errorOnRedirect",
      ],
    },
    jsScript: {
      propDefinition: [
        webscrapingAI,
        "jsScript",
      ],
    },
    textFormat: {
      type: "string",
      label: "Text Format",
      description: "The format of the returned text content. Default: `json`",
      options: [
        "plain",
        "xml",
        "json",
      ],
      default: "json",
      optional: true,
    },
    returnLinks: {
      type: "boolean",
      label: "Return Links",
      description: "Whether to include links in the returned text content. Works only when Text Format is `json`.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.webscrapingAI.pageTextByUrl({
      $,
      params: {
        url: this.targetUrl,
        headers: utils.stringifyHeaders(this.headers),
        timeout: this.timeout,
        js: this.js,
        js_timeout: this.jsTimeout,
        wait_for: this.waitFor,
        proxy: this.proxy,
        country: this.country,
        custom_proxy: this.customProxy,
        device: this.device,
        error_on_404: this.errorOn404,
        error_on_redirect: this.errorOnRedirect,
        js_script: this.jsScript,
        text_format: this.textFormat,
        return_links: this.returnLinks,
      },
    });
    $.export("$summary", `Successfully scraped text from ${this.targetUrl}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
WebScraping.AI	`webscrapingAI`	`app`	This component uses the WebScraping.AI app.
Target URL	`targetUrl`	`string`	The URL of the webpage to scrape.
Headers	`headers`	`object`	HTTP headers to pass to the target page
Timeout	`timeout`	`integer`	Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000).
JS	`js`	`boolean`	Execute on-page JavaScript using a headless browser (`true` by default)
JS Timeout	`jsTimeout`	`integer`	Maximum JavaScript rendering time in ms. Default: `2000`
Wait For	`waitFor`	`string`	CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
Proxy	`proxy`	`string`	Select a value from the drop down menu:`datacenterresidential`
Country	`country`	`string`	Select a value from the drop down menu:`usgbdeitfrcaesrujpkrin`
Custom Proxy	`customProxy`	`string`	Your own proxy URL to use instead of our built-in proxy pool in "http://user:password@host:port" format (Smartproxy for example).
Device	`device`	`string`	Select a value from the drop down menu:`desktopmobiletablet`
Error on 404	`errorOn404`	`boolean`	Return error on 404 HTTP status on the target page (`false` by default)
Error on Redirect	`errorOnRedirect`	`boolean`	Return error on redirect on the target page (`false` by default)
JS Script	`jsScript`	`string`	Custom JavaScript code to execute on the target page. Example: `document.querySelector('button').click();`
Text Format	`textFormat`	`string`	Select a value from the drop down menu:`plainxmljson`
Return Links	`returnLinks`	`boolean`	Whether to include links in the returned text content. Works only when Text Format is `json`.