snapapi-js

snapapi-js

Official JavaScript/TypeScript client for SnapAPI — a REST API for screenshots, PDFs, QR codes, and web content extraction. No browser infrastructure required.

Features

• Screenshots: Capture full-page or viewport screenshots of any URL
• PDFs: Convert markdown to PDF or HTML pages to PDF
• Markdown: Convert HTML to markdown
• QR codes: Generate QR codes from any text
• Open Graph: Extract OG metadata from URLs
• Content extraction: Extract text/HTML from web pages

Install

npm install snapapi-js

Quick Start

import SnapAPI from 'snapapi-js';
import { writeFileSync } from 'fs';

const client = new SnapAPI({ apiKey: 'your-api-key' });

// Take a screenshot
const screenshot = await client.screenshot({ url: 'https://example.com' });
writeFileSync('screenshot.png', screenshot);

// Convert markdown to PDF
const pdf = await client.markdownToPDF({ content: '# Hello World\n\nThis is a PDF.' });
writeFileSync('document.pdf', pdf);

// Generate a QR code
const qr = await client.qr({ text: 'https://example.com', size: 256 });
writeFileSync('qr.png', qr);

// Extract Open Graph metadata
const og = await client.og({ url: 'https://example.com' });
console.log(og);

API Reference

new SnapAPI(options)

Option	Type	Required	Description
apiKey	string	Yes	Your SnapAPI key (free: 100 calls/month)
baseUrl	string	No	Custom base URL (default: https://api.opspawn.com)

screenshot(options) → Promise<Uint8Array>

Option	Type	Default	Description
url	string	Required	URL to screenshot
width	number	1280	Viewport width
height	number	720	Viewport height
fullPage	boolean	false	Capture full page
format	string	png	png, jpeg, or webp
quality	number	80	Image quality (1-100)
delay	number	0	Wait time in ms before capture

markdownToPDF(options) → Promise<Uint8Array>

Option	Type	Default	Description
content	string	Required	Markdown content
title	string		PDF title
format	string	A4	Page size: A4, Letter, Legal

og(options) → Promise<object>

Returns Open Graph metadata for a URL.

toMarkdown(options) → Promise<object>

Converts an HTML page to Markdown.

qr(options) → Promise<Uint8Array>

Option	Type	Default	Description
text	string	Required	Text/URL to encode
size	number	256	Image size in pixels
format	string	png	png or svg

Pricing

• Free: 100 calls/month — no credit card required
• Pro: $19/month — 10,000 calls/month
• Business: $99/month — 100,000 calls/month

Get your free API key at opspawn.com/snapapi.

Links

• Pricing & Docs
• API Explorer
• GitHub