# webscreenshot-io

> Generate screenshots with Node.js using Webscreenshot.io API.

Latest version **1.1.0** (published 2026-10-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install webscreenshot-io
pnpm add webscreenshot-io
yarn add webscreenshot-io
bun add webscreenshot-io
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2026-10-20 |
| First published | 2022-09-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | Andy Feliciotti |
| Maintainers | andyfeliciotti |
| Keywords | webscreenshot, webscreenshot.io, screenshots, screenshot, chrome, headless, puppeteer, url2png |

## Links

- npm: https://www.npmjs.com/package/webscreenshot-io
- Repository: https://github.com/webscreenshot/webscreenshot-node
- Homepage: https://webscreenshot.io
- Issues: https://github.com/webscreenshot/webscreenshot-node/issues
- npm.io page: https://npm.io/package/webscreenshot-io

## Dependencies (1)

- [qs](https://npm.io/package/qs.md) ^6.16.1

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2026-10-20
- 1.0.2 — 2023-01-26
- 1.0.1 — 2022-09-11
- 1.0.0 — 2022-09-11

## README

# WebScreenshot.io Screenshot API

Generate screenshots of web pages using the WebScreenshot.io API. Perfect for generating thumbnails of web pages, or for generating screenshots of web pages for use in your own applications.

Sign up for an API key and secret at [WebScreenshot.io](https://webscreenshot.io).

## Installation

```
npm install webscreenshot-io
```

Requires Node.js 18 or newer. TypeScript types are included.

## Node.js Usage Example

```js
import Webscreenshot from 'webscreenshot-io';
// or: const Webscreenshot = require('webscreenshot-io');

// API key and secret from webscreenshot.io
const webscreenshot = Webscreenshot(API_KEY, API_SECRET);

// Available options: https://webscreenshot.io/documentation/options/options/
const options = {
  page: 'google.com',
  height: 600,
  width: 800,
  format: 'jpeg'
}

const imageUrl = webscreenshot.screenshotUrl(options);
console.log(imageUrl);
```

The secret signs each URL so nobody can reuse your key with different options. Keep it server-side. Passing only the API key (`Webscreenshot(API_KEY)`) builds unsigned URLs.

---
_Source: https://npm.io/package/webscreenshot-io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._