Screenshot & PDF API

Python wrapper for the Screenshot & PDF API on RapidAPI.

Capture screenshots, generate PDFs, extract page metadata, and render HTML/CSS to images — all from a single, zero-dependency package.

Installation

pip install screenshot-pdf-api

Quick Start

from screenshot_pdf_api import ScreenshotAPI

api = ScreenshotAPI("your-rapidapi-key")

# Check API status
print(api.health())

# Take a screenshot
png = api.screenshot("https://example.com")
with open("example.png", "wb") as f:
    f.write(png)

Get Your API Key

1. Go to RapidAPI - Screenshot & PDF API
2. Subscribe to a plan (free tier available)
3. Copy your X-RapidAPI-Key from the dashboard

Endpoints

Free Tier

api = ScreenshotAPI("your-key")

# Screenshot any URL → PNG, JPEG, or WebP
png = api.screenshot("https://example.com")

# Full-page screenshot with custom viewport
img = api.screenshot(
    "https://example.com",
    width=1920,
    height=1080,
    full_page=True,
    format="jpeg",
    quality=90,
)

# Screenshot a specific element
element = api.screenshot(
    "https://example.com",
    selector="#main-content",
)

# Wait for dynamic content before capture
img = api.screenshot(
    "https://example.com",
    delay=2000,  # wait 2 seconds
)

Basic Tier

# Generate a PDF from any URL
pdf = api.pdf("https://example.com")
with open("page.pdf", "wb") as f:
    f.write(pdf)

# PDF with custom options
pdf = api.pdf(
    "https://example.com",
    format="Letter",
    landscape=True,
    print_background=True,
    margin="narrow",
)

# Extract page metadata (title, OG tags, favicon, etc.)
meta = api.metadata("https://example.com")
print(meta["title"])
print(meta["og"])
print(meta["favicon"])

Pro Tier

# Render HTML/CSS to image
html = """
<html>
<body style="background: linear-gradient(135deg, #667eea, #764ba2);
             color: white; font-family: Arial; padding: 40px;">
  <h1>Hello World</h1>
  <p>Rendered from raw HTML</p>
</body>
</html>
"""
img = api.screenshot_html(html, width=800, height=600)
with open("rendered.png", "wb") as f:
    f.write(img)

Error Handling

The library raises specific exceptions for different error types:

from screenshot_pdf_api import (
    ScreenshotAPI,
    ScreenshotAuthError,
    ScreenshotForbiddenError,
    ScreenshotRateLimitError,
    ScreenshotAPIError,
)

api = ScreenshotAPI("your-key")

try:
    img = api.screenshot_html("<h1>Pro feature</h1>")
except ScreenshotAuthError:
    print("Invalid API key")
except ScreenshotForbiddenError:
    print("Upgrade your plan for this endpoint")
except ScreenshotRateLimitError:
    print("Rate limited — slow down or upgrade")
except ScreenshotAPIError as e:
    print(f"API error [{e.status_code}]: {e.message}")

Configuration

api = ScreenshotAPI(
    api_key="your-key",
    timeout=60,       # request timeout in seconds (default: 30)
)

Requirements

• Python 3.8+
• Zero dependencies — uses only urllib.request from the standard library

License

MIT