screenshotapis 0.1.0

Python SDK for ScreenshotAPIs — convert URLs or HTML to screenshots and PDFs

screenshotapis

Python SDK for ScreenshotAPIs — convert URLs or HTML to screenshots and PDFs with a single function call.

Install

pip install screenshotapis

Quick Start

from screenshotapis import Client

client = Client("your_api_key")

# Screenshot a URL
client.screenshot("https://example.com", file="screenshot.png")

# Screenshot with options
client.screenshot(
    "https://example.com",
    format="jpeg",
    width=1920,
    height=1080,
    full_page=True,
    file="full_page.jpeg",
)

# Render HTML to PDF
client.pdf(html="<h1>Invoice #42</h1><p>Total: $100</p>", file="invoice.pdf")

# PDF from URL
client.pdf("https://example.com", format="Letter", file="page.pdf")

Async Support

from screenshotapis.client import AsyncClient

async with AsyncClient("your_api_key") as client:
    await client.screenshot("https://example.com", file="screenshot.png")
    await client.pdf(html="<h1>Hello</h1>", file="doc.pdf")

Screenshot Options

Parameter	Type	Default	Description
url	str	None	URL to screenshot
html	str	None	Raw HTML to render
format	str	"png"	"png", "jpeg", or "webp"
width	int	1280	Viewport width
height	int	720	Viewport height
full_page	bool	False	Capture full scrollable page
dark_mode	bool	False	Enable dark color scheme
device_scale_factor	int	1	Pixel density (2 for retina)
selector	str	None	CSS selector for element capture
delay_ms	int	0	Wait before capture (ms)
file	str	None	Save to file path

PDF Options

Parameter	Type	Default	Description
url	str	None	URL to render
html	str	None	Raw HTML to render
format	str	"A4"	"A4", "Letter", "Legal", "A3", "Tabloid"
landscape	bool	False	Landscape orientation
print_background	bool	True	Include backgrounds
file	str	None	Save to file path

Error Handling

from screenshotapis.client import ScreenshotAPIError

try:
    client.screenshot("https://example.com", file="shot.png")
except ScreenshotAPIError as e:
    print(e.status_code, e.detail)

Get Your API Key

Sign up at screenshotapis.org — free tier with 100 renders/month, no credit card required.