Getting Started
Quick start guide for the Screenshots API
Getting Started with Screenshots API
The Screenshots API is a powerful serverless service that allows you to capture high-quality screenshots of web pages with advanced features like ad blocking, cookie consent handling, and device emulation.
Prerequisites
-
Get Your API Key:
- Go to the API Keys page
- Copy your API key from the API Keys Page
-
Basic understanding of HTTP requests
Basic Usage
The API is simple to use and supports GET requests with query parameters. Here's a basic example:
Key Features
The API supports several powerful features through query parameters:
- Format Control: Choose between PNG or JPEG with
fmt
parameter - Quality Settings: Adjust image quality with
qual
parameter (0-100) - Page Capture Options:
full
: Capture full page heightwidth
/height
: Set viewport dimensionsscale
: Control device pixel ratio
- Content Handling:
ads
: Enable/disable ad blockingcookie
: Handle cookie consent bannerstrack
: Block tracking scripts
- Device Emulation:
device
: Choose device type (desktop/mobile)mobile
: Enable mobile viewporttouch
: Enable touch eventsland
: Force landscape mode
- Rendering Options:
dark
: Enable dark modetrans
: Enable transparent background
- Performance Controls:
wait
: Wait time before capture (ms)load
: Page load strategy (networkidle)timeout
: Maximum capture time (seconds)
Next Steps
- Learn about advanced features
- Explore bulk screenshot capabilities