# Google Search API — Search API

> Run a Google web search. Returns organic_results alongside whichever other blocks Google included for the query See the documentation

- Key: `search_api-google-search`
- Type: Action (Read-only)
- Version: 0.0.4
- App: Search API (`search_api`) — https://pipedream.com/apps/search-api.md
- This page (HTML): https://pipedream.com/apps/search-api/actions/google-search
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/search_api/actions/google-search/google-search.mjs

## Description

Run a Google web search. Returns `organic_results` alongside whichever other blocks Google included for the query [See the documentation](https://www.searchapi.io/docs/google)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `q` | `string` | Yes | The search query |
| `device` | `string` | No | The device to use for the search |
| `domain` | `string` | No | The domain to use for the search |
| `hl` | `string` | No | The default parameter en defines the interface language of the search. |
| `gl` | `string` | No | The default parameter us defines the country of the search. |
| `timePeriod` | `string` | No | This parameter restricts results to URLs based on date. |
| `num` | `integer` | No | This parameter specifies the number of results to display per page. Use in combination with the page parameter to implement pagination functionality. |
| `page` | `integer` | No | This parameter indicates which page of results to return. By default, it is set to 1. Use in combination with the num parameter to implement pagination. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "search_api",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "search_api-google-search",
  arguments: {
    q: "Query",
    device: "Device",
  },
})
```

**TypeScript**

```ts
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: "search_api-google-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    search_api: { authProvisionId: "apn_xxxxxxx" },
    q: "Query",
    device: "Device",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "search_api-google-search",
    "configured_props": {
      "search_api": { "authProvisionId": "apn_xxxxxxx" },
      "q": "Query",
      "device": "Device"
    }
  }'
```

---

- App: https://pipedream.com/apps/search-api.md · All apps: https://pipedream.com/apps