Quickstart

​

GET Request Example

Use a GET request when you prefer to pass parameters via querystrings. For example, to capture a screenshot:

https://api.screenshotmax.com/v1/screenshot
?access_key=YOUR_ACCESS_KEY
&url=https://example.com

​

POST Request Example

For POST requests, you send a JSON payload. Here’s an example for capturing an animated screenshot:

POST "https://api.screenshotmax.com/v1/screenshot"
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}

​

Request Parameters Overview

All endpoints require the following basic parameters:

• access_key (string): Your unique API key. (required)
• url (string): The target webpage URL. (required)

Additional parameters allow you to customize your requests (e.g., viewport settings, delay, caching, and more). For a full list of parameters and their constraints, please refer to our API References.

​

Handling API Responses

The API returns responses that include your captured media (screenshot, animated screenshot, PDF, or scraped content) along with relevant metadata (such as HTTP status, headers, and additional capture details).