Extract Data From URL with Automatic Data Extraction API

Pipedream makes it easy to connect APIs for Automatic Data Extraction and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Extract Data From URL with the Automatic Data Extraction API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Extract Data From URL with the Automatic Data Extraction API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Extract Data From URL action
1. Connect your Automatic Data Extraction account
2. Configure URL
3. Select a Page Type
4. Optional- Configure Meta
5. Optional- Configure Article Body Raw
6. Optional- Configure Full HTML
7. Optional- Configure Custom HTML
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#

Extract Data From URL with Automatic Data Extraction API on Booking Cancelled from Cal.com API

Cal.com + Automatic Data Extraction

Try it

Extract Data From URL with Automatic Data Extraction API on New Channel Updates (Instant) from Telegram Bot API

Telegram Bot + Automatic Data Extraction

Try it

Extract Data From URL with Automatic Data Extraction API on New Requests from HTTP / Webhook API

HTTP / Webhook + Automatic Data Extraction

Try it

Extract Data From URL with Automatic Data Extraction API on New Submission from Typeform API

Typeform + Automatic Data Extraction

Try it

Extract Data From URL with Automatic Data Extraction API on New Submission (Instant) from Jotform API

Jotform + Automatic Data Extraction

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.

Extract Data From URL on Automatic Data Extraction

Description:Extract data from a specified URL [See the docs here](https://docs.zyte.com/automatic-extraction-integrations.html#node-js)

Version:0.0.1

Key:automatic_data_extraction-extract-data-from-url

View on GitHub

Code#

import automaticDataExtraction from "../../automatic_data_extraction.app.mjs";
import { PAGE_TYPES } from "../../common/constants.mjs";
import { clearObj } from "../../common/utils.mjs";

export default {
  key: "automatic_data_extraction-extract-data-from-url",
  name: "Extract Data From URL",
  version: "0.0.1",
  description: "Extract data from a specified URL [See the docs here](https://docs.zyte.com/automatic-extraction-integrations.html#node-js)",
  type: "action",
  props: {
    automaticDataExtraction,
    url: {
      type: "string",
      label: "URL",
      description: "URL of web page to extract from. Must be a valid `http://` or `https:// URL`.",
    },
    pageType: {
      type: "string",
      label: "Page Type",
      description: "Type of extraction to perform.",
      options: PAGE_TYPES,
    },
    meta: {
      type: "string",
      label: "Meta",
      description: "User UTF-8 string, which will be passed through the extraction pipeline and returned in the query result. Max size 4 Kb.",
      optional: true,
    },
    articleBodyRaw: {
      type: "boolean",
      label: "Article Body Raw",
      description: "Whether or not to include article HTML in article extractions. True by default. Setting this to false can reduce response size significantly if HTML is not required.",
      optional: true,
    },
    fullHtml: {
      type: "boolean",
      label: "Full HTML",
      description: "Include the full, raw HTML of the target web page in the query result. This is a premium feature that is disabled by default. [Open a support ticket](https://support.zyte.com/support/tickets/new) if you wish to have it enabled for your account.",
      optional: true,
    },
    customHtml: {
      type: "string",
      label: "Custom HTML",
      description: "HTML source to be scraped. Extraction will be done from the provided HTML with additional resources (images, CSS, etc.) downloaded from the provided url. JavaScript processing will be disabled. The String should be UTF-8 encoded. The maximum length is 2,000,000 characters, longer requests will be rejected.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      automaticDataExtraction,
      ...data
    } = this;

    const response = await automaticDataExtraction.extractData({
      $,
      data: JSON.stringify([
        clearObj(data),
      ]),
    });

    $.export("$summary", "The data was successfully extracted!");
    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
Automatic Data Extraction	`automaticDataExtraction`	`app`	This component uses the Automatic Data Extraction app.
URL	`url`	`string`	URL of web page to extract from. Must be a valid `http://` or `https:// URL`.
Page Type	`pageType`	`string`	Select a value from the drop down menu:`articlearticleListcommentsforumPostsjobPostingproductproductListrealEstatereviewsvehicle`
Meta	`meta`	`string`	User UTF-8 string, which will be passed through the extraction pipeline and returned in the query result. Max size 4 Kb.
Article Body Raw	`articleBodyRaw`	`boolean`	Whether or not to include article HTML in article extractions. True by default. Setting this to false can reduce response size significantly if HTML is not required.
Full HTML	`fullHtml`	`boolean`	Include the full, raw HTML of the target web page in the query result. This is a premium feature that is disabled by default. Open a support ticket if you wish to have it enabled for your account.
Custom HTML	`customHtml`	`string`	HTML source to be scraped. Extraction will be done from the provided HTML with additional resources (images, CSS, etc.) downloaded from the provided url. JavaScript processing will be disabled. The String should be UTF-8 encoded. The maximum length is 2,000,000 characters, longer requests will be rejected.

Authentication#

Automatic Data Extraction uses API keys for authentication. When you connect your Automatic Data Extraction account, Pipedream securely stores the keys so you can easily authenticate to Automatic Data Extraction APIs in both code and no-code steps.

To retrieve your API Key,