There is an official SDK on npm (getsnap), written in TypeScript with bundled types. It also ships a CLI, so you can capture something from a terminal without writing any code.

Install

npm install getsnap

Your first screenshot in Node.js

One POST, one JSON body, one URL back. The response is a CDN link to the finished image.

Node.js SDK

import GetSnap from "getsnap";

const snap = new GetSnap("sk_live_YOUR_KEY");

const { url } = await snap.screenshot({
  url: "https://github.com",
  format: "png",
});
console.log(url); // CDN URL to your screenshot

fetch (no SDK)

const response = await fetch("https://api.getsnap.dev/v1/screenshot", {
  method: "POST",
  headers: {
    "X-API-Key": "sk_live_YOUR_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://github.com", format: "png" }),
});

const data = await response.json();
console.log(data.url);

From the command line

The SDK installs a CLI, which is the fastest way to confirm your key works:

export GETSNAP_KEY=sk_live_YOUR_KEY

npx getsnap screenshot https://news.ycombinator.com
npx getsnap screenshot https://news.ycombinator.com --out hn.png
npx getsnap pdf        https://news.ycombinator.com --out hn.pdf --full-page
npx getsnap og         https://blog.example.com/post --out og.png

Full-page captures and other options

Every option is a field in the same JSON body. The common ones are full-page capture, popup and ad removal, viewport size, and lazy-load scrolling.

const result = await snap.screenshot({
  url: "https://example.com",
  format: "png",
  viewport_width: 1280,
  viewport_height: 720,
  full_page: true,
  remove_popups: true,
  block_ads: true,
  lazy_load: true,
  extract_text: true,
});
console.log(result.url);

Saving the image to disk

By default you get a CDN URL. Ask for a binary response instead and you get the bytes directly, which saves a round-trip when you are storing the file yourself.

import { writeFile } from "fs/promises";

const buffer = await snap.screenshotBinary({
  url: "https://example.com",
  format: "webp",
  quality: 90,
});
await writeFile("screenshot.webp", Buffer.from(buffer));

Handling errors

Every failure returns JSON with an error code and a human-readable message. These are the ones worth branching on:

Status	error	What it means
400	validation_error	A field is missing or out of range. The body names the field.
401	unauthorized	Missing or unknown API key.
402	quota_exceeded	Monthly capture limit reached.
429	rate_limit_exceeded	Too many requests this minute. Back off and retry.
500	capture_failed	The page could not be rendered - usually a timeout on a page that never settles.

const response = await fetch("https://api.getsnap.dev/v1/screenshot", {
  method: "POST",
  headers: {
    "X-API-Key": "sk_live_YOUR_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
});

if (!response.ok) {
  // e.g. { error: "quota_exceeded", message: "..." }
  const { error, message } = await response.json();
  throw new Error(`${response.status} ${error}: ${message}`);
}

const { url } = await response.json();

Rate limits and quotas

Plan	Captures / month	Requests / minute
Free	100	5
Starter	5,000	30
Pro	25,000	60
Business	100,000	120

Exceeding the per-minute limit returns 429; exceeding the monthly quota returns 402. See pricing for the full breakdown.

Frequently asked questions

Next steps

• Code examples — every feature, with cURL, Node.js and Python tabs
• API reference — every request field and response shape
• Playground — try a capture in the browser before writing any Node.js
• Pricing — plans, quotas and overage

Related reading

• Dynamic OG images in Node.js — a complete worked example
• PDF invoices from HTML in Node.js — the same client, different output format