API Reference

ScreenCapr provides a high-performance REST API for capturing website screenshots. Unlike other services, we stream results directly to you with zero storage overhead.

Base URL

https://api.screencapr.com

Single Screenshot

POST

Capture a single URL and receive the raw binary image data instantly.

/api/screenshot

Body Parameters

url
string

RequiredThe URL of the website to capture (must include http/https).

Default:

options.width
number (100-3840)

Viewport width.

Default: 1920

options.height
number (100-2160)

Viewport height.

Default: 1080

options.fullPage
boolean

Capture entire scrollable content.

Default: false

options.format
enum

Image format.

Default: png

options.quality
number (1-100)

JPEG quality (if format is jpeg).

Default: 80

options.timeout
number (5000-60000)

Capture timeout in ms.

Default: 30000

Success Response

200 OK

Returns raw binary data with image/png or image/jpeg header.

Batch Screenshots

POST

Capture up to 10 URLs simultaneously and receive a single ZIP file containing all results.

urls
Required

Array of strings. Max 10 URLs.

options

Same shared options as single screenshot.

200 OK

Returns binary ZIP data with application/zip header.

Health Check

GET

Monitor server health, uptime, and resource usage.

{
  "status": "ok",
  "timestamp": "2024-01-19T14:48:00Z",
  "uptime": 3600,
  "memory": {
    "used": 142,
    "total": 512,
    "percentage": 27
  },
  "activeBrowsers": 2
}

Error Handling

When something goes wrong, the API returns a standard JSON error structure.

400

Bad Request

Validation failed for provided parameters.

408

Timeout

Screenshot took longer than defined limit.

429

Rate Limit

Maximum requests per window exceeded.

500

Server Error

Unexpected error during capture process.