Screenshot API

The screenshot API allows you to take a full-page screenshot of any website. It's a simple API that returns a PNG image of the website.

Auth

Follow the auth guide to add the required headers and your API key with requests.

Usage

Key	Value	Help
Endpoint	`api.urlmeta.org/screenshot`	Should always be accessed over `https`
Method	`GET`

Query Parameters

Key	Value	Help
url	The URL you want the screenshot of.	required Full URL with protocol - E.g.: `https://backupdiary.com`
fullpage	Whether to take a full page screenshot or not. Pro account only.	optional `true` or `false` - Default: `false`

Example

To take a screenshot of https://backupdiary.com, we'll use:

https://api.urlmeta.org/screenshot?url=https://backupdiary.com

Response

The API will always return JSON response. Here's the response schema returned by the Screenshot API.

{
  "result": {
    "status": "OK"
  },
  "screenshot": {
    "file": "... URL of the screenshot file ..."
  }
}

ℹ️

The screenshot.file will only be valid for 5 minutes. After that, you'll have to request a new screenshot. Make sure you store/download it before it expires.

Render API API Errors