# Get Website Screenshot — GetScreenshot

> Capture a screenshot from a live website. See the documentation

- Key: `getscreenshot-get-website-screenshot`
- Type: Action (Read-only)
- Version: 0.0.3
- App: GetScreenshot (`getscreenshot`) — https://pipedream.com/apps/getscreenshot.md
- This page (HTML): https://pipedream.com/apps/getscreenshot/actions/get-website-screenshot
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/getscreenshot/actions/get-website-screenshot/get-website-screenshot.mjs

## Description

Capture a screenshot from a live website. [See the documentation](https://docs.rasterwise.com/docs/getscreenshot/api-reference-0/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `url` | `string` | Yes | URL of the website / page you want to screenshot. Should start with http:// or https:// |
| `format` | `string` | No | The file type/format in which you want to get your capture. If pdf is selected, an A4 PDF of the passed website will be generated, rendered the same as if you were printing it from your browser. |
| `email` | `string` | No | If specified, a formatted email will be sent to this email address, including the captured image and details of the capture. |
| `element` | `string` | No | If you need to target specific DOM elements instead of taking dimension-based screenshots, you can specify an element DOM selector, e.g. #colordiv to target a div with the id "colordiv". |
| `additionalParams` | `object` | No | Additional parameters (key/value pairs) to send in this request. See the documentation for all available parameters. |

## 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": "getscreenshot",
      },
    },
  },
)

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: "getscreenshot-get-website-screenshot",
  arguments: {
    url: "Website URL",
    format: "Image Format",
  },
})
```

**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: "getscreenshot-get-website-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    getscreenshot: { authProvisionId: "apn_xxxxxxx" },
    url: "Website URL",
    format: "Image Format",
  },
})

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": "getscreenshot-get-website-screenshot",
    "configured_props": {
      "getscreenshot": { "authProvisionId": "apn_xxxxxxx" },
      "url": "Website URL",
      "format": "Image Format"
    }
  }'
```

---

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