View as Markdown
SERPhouse icon

SERPhouse ACTION

Perform Search

Performs a search using the Serphouse API. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SERPhouse account once, then configure and run Perform Search from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "serphouse-perform-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    serphouse: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    domain: "Domain",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Perform Search inputs
Property Type Description
query Query string
Search phrase that you want to search
Required
domain Domain string
The domain to search
Required Dynamic
language Language string
The language to use for the search
Required Dynamic
device Device string
The device to use for the search
Required
serpType SERP Type string
The type of SERP to use for the search
Required
locationId Location string
Search for a location or enter a location ID. Required for Google and Bing searches.
Optional Dynamic
verbatim Verbatim boolean
If true, the search will be performed verbatim
Optional
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.
Optional
page Page integer
Give specific page to get the result of that page number. By default it will get you first page
Optional
numResults Number of Results integer
Define number of result you want to get per page. By default you will get top 100 results.
Optional
dateRange Date Range string
Parameter defines the date range for the search
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
serphouse-perform-search
Version
0.0.1
App
SERPhouse
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes