View as Markdown
Oxylabs icon

Oxylabs ACTION

Scrape with Query

Extract data using a search query. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Oxylabs account once, then configure and run Scrape with Query 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: "oxylabs-scrape-with-query",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    oxylabs: { authProvisionId: "apn_xxxxxxx" },
    source: "Source",
    query: "Query",
  },
})

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.

Scrape with Query inputs
Property Type Description
source Source string
Sets the scraper that will be used to process your request
Required
query Query string
The query to search for. See the documentation for more information about specific sources/targets
Required
geoLocation Geo Location string
The geo location to scrape from. See the guide for using this property.
Optional
parse Parse boolean
Set to true to receive structured data
Optional
render Render string
Set to html to get the raw output of the rendered page
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
oxylabs-scrape-with-query
Version
0.0.3
App
Oxylabs
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes