Perform Search with SERPhouse API on New Package Version from npm API

Pipedream makes it easy to connect APIs for SERPhouse, npm and 2,900+ other apps remarkably fast.

Trigger workflow on

New Package Version from the npm API

Next, do this

Perform Search with the SERPhouse 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#

This integration creates a workflow with a npm trigger and SERPhouse action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Perform Search action
1. Connect your SERPhouse account
2. Configure Query
3. Select a Domain
4. Select a Language
5. Select a Device
6. Select a SERP Type
7. Configure locationAlert
8. Optional- Select a Location
9. Optional- Configure Verbatim
10. Optional- Configure GFilter
11. Optional- Configure Page
12. Optional- Configure Number of Results
13. Optional- Select a Date Range
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

Trigger 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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Perform Search on SERPhouse

Description:Performs a search using the Serphouse API. [See the documentation](https://docs.serphouse.com/serp-api/live-using-http-get-method)

Version:0.0.1

Key:serphouse-perform-search

View on GitHub

SERPhouse Overview#

The SERPhouse API provides a way to fetch real-time search engine results pages (SERPs) from Google and Bing. With it, you can gather SEO data, monitor keyword rankings, and gain insights into search trends. On Pipedream, you can leverage this API to build serverless workflows that automate SEO tasks, conduct competitive analysis, and integrate with other apps to enhance your digital marketing strategies.

Action Code#

import serphouse from "../../serphouse.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "serphouse-perform-search",
  name: "Perform Search",
  description: "Performs a search using the Serphouse API. [See the documentation](https://docs.serphouse.com/serp-api/live-using-http-get-method)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    serphouse,
    query: {
      propDefinition: [
        serphouse,
        "query",
      ],
    },
    domain: {
      propDefinition: [
        serphouse,
        "domain",
      ],
    },
    language: {
      propDefinition: [
        serphouse,
        "language",
        ({ domain }) => ({
          domain,
        }),
      ],
    },
    device: {
      type: "string",
      label: "Device",
      description: "The device to use for the search",
      options: [
        "desktop",
        "tablet",
        "mobile",
      ],
    },
    serpType: {
      type: "string",
      label: "SERP Type",
      description: "The type of SERP to use for the search",
      options: [
        "web",
        "news",
        "image",
      ],
    },
    locationAlert: {
      propDefinition: [
        serphouse,
        "locationAlert",
      ],
    },
    locationId: {
      propDefinition: [
        serphouse,
        "locationId",
        ({ domain }) => ({
          domain,
        }),
      ],
      optional: true,
    },
    verbatim: {
      type: "boolean",
      label: "Verbatim",
      description: "If true, the search will be performed verbatim",
      optional: true,
    },
    gfilter: {
      type: "boolean",
      label: "GFilter",
      description: "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `true` (default) to enable these filters, or `false` to disable these filters.",
      optional: true,
      default: true,
    },
    page: {
      type: "integer",
      label: "Page",
      description: "Give specific page to get the result of that page number. By default it will get you first page",
      optional: true,
    },
    numResults: {
      type: "integer",
      label: "Number of Results",
      description: "Define number of result you want to get per page. By default you will get top 100 results.",
      optional: true,
    },
    dateRange: {
      propDefinition: [
        serphouse,
        "dateRange",
      ],
    },
  },
  async run({ $ }) {
    const type = this.serphouse.getDomainType(this.domain);
    if (!this.locationId && (type === "google" || type === "bing")) {
      throw new ConfigurationError("Location is required for Google and Bing searches");
    }
    const response = await this.serphouse.performSearch({
      $,
      params: {
        q: this.query,
        domain: this.domain,
        lang: this.language,
        device: this.device,
        serp_type: this.serpType,
        loc_id: this.locationId,
        verbatim: this.verbatim
          ? "1"
          : "0",
        gfilter: this.gfilter
          ? "1"
          : "0",
        page: this.page,
        num_result: this.numResults,
        date_range: this.dateRange,
      },
    });
    if (response.status === "success") {
      $.export("$summary", `Successfully performed search for "${this.query}".`);
    }
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
SERPhouse	`serphouse`	`app`	This component uses the SERPhouse app.
Query	`query`	`string`	Search phrase that you want to search
Domain	`domain`	`string`	Select a value from the drop down menu.
Language	`language`	`string`	Select a value from the drop down menu.
Device	`device`	`string`	Select a value from the drop down menu:`desktoptabletmobile`
SERP Type	`serpType`	`string`	Select a value from the drop down menu:`webnewsimage`
Location	`locationId`	`string`	Select a value from the drop down menu.
Verbatim	`verbatim`	`boolean`	If true, the search will be performed verbatim
GFilter	`gfilter`	`boolean`	Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `true` (default) to enable these filters, or `false` to disable these filters.
Page	`page`	`integer`	Give specific page to get the result of that page number. By default it will get you first page
Number of Results	`numResults`	`integer`	Define number of result you want to get per page. By default you will get top 100 results.
Date Range	`dateRange`	`string`	Select a value from the drop down menu:`{ "label": "Past hour", "value": "h" }{ "label": "Past 24 hours", "value": "d" }{ "label": "Past week", "value": "w" }{ "label": "Past month", "value": "m" }{ "label": "Past year", "value": "y" }`