Quickstart

1

Create an account

Sign up at app.screenshotly.dev/register. No credit card required — the free plan includes 100 screenshots per month.

2

Get your API key

After registering, go to API settings in your dashboard. Copy your API key and store it securely — you’ll need it for every request.

Never expose your API key in client-side code or public repositories. Store it in environment variables.

export SCREENSHOTLY_API_KEY="your-api-key-here"

3

Capture your first screenshot

Choose your preferred method:

import { Screenshotly } from 'screenshotly-js';

const client = new Screenshotly(process.env.SCREENSHOTLY_API_KEY);

const screenshot = await client.capture({
  url: 'https://example.com',
  viewport_width: 1280,
  viewport_height: 800,
  format: 'png'
});

if (screenshot.success) {
  console.log('Screenshot URL:', screenshot.data.imageUrl);
}

import requests
import os

response = requests.post(
    'https://api.screenshotly.dev/v1/capture',
    headers={
        'X-API-Key': os.environ['SCREENSHOTLY_API_KEY'],
        'Content-Type': 'application/json'
    },
    json={
        'url': 'https://example.com',
        'options': {
            'format': 'png',
            'viewport_width': 1280,
            'viewport_height': 800,
            'response_type': 'json'
        }
    }
)

data = response.json()
print('Image URL:', data['data']['image_url'])

curl -X POST https://api.screenshotly.dev/v1/capture \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "options": {
      "format": "png",
      "viewport_width": 1280,
      "viewport_height": 800
    }
  }' \
  --output screenshot.png

By default, the API returns the screenshot as a binary image. To get a JSON response with metadata, set response_type to json:

{
  "success": true,
  "data": {
    "id": "67b8a1c2d3e4f5a6b7c8d9e0",
    "url": "https://example.com",
    "image_url": "https://cdn.screenshotly.dev/screenshots/67b8a1c2d3e4f5a6b7c8d9e0.png",
    "status": "completed",
    "metadata": {
      "file_size": 245760,
      "format": "png",
      "dimensions": { "width": 1280, "height": 800 }
    }
  },
  "remaining_credits": 99
}

Getting started

Capture options

Advanced

Integrations

Account

Next steps

Full-page captures

Device emulation

Batch processing

API reference

​Next steps

Full-page captures

Device emulation

Batch processing

API reference

Next steps