Browshot API

by browshot.com

Overview

Easily make screenshots of web pages in any screen size, as any device

Browshot is a development API from browshot.com. Requests are authenticated with an API key. It is served over HTTPS and allows browser requests (CORS). Its OpenAPI description documents 17 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Yes
Category: Development
Base URL: https://api.browshot.com/api/v1
Version: 1.17.0
Endpoints: 17
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.browshot.com/api/v1/account/info" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://api.browshot.com/api/v1/account/info", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.browshot.com/api/v1/account/info",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/account/info`	Get information about your account
POST	`/batch/ceate`	Requests thousands of screenshtos at once
GET	`/batch/info`	Get the batch status
GET	`/browser/info`	Get information about a browser
GET	`/browser/list`	Get all browsers
GET	`/instance/info`	Get information about an instance
GET	`/instance/list`	Get all instances
GET	`/screenshot/create`	Request a screenshot
GET	`/screenshot/delete`	Delete screenshot data
GET	`/screenshot/host`	Host thumbnails on your own S3 account or on Browshot.
GET	`/screenshot/html`	Get the HTML code
GET	`/screenshot/info`	Query screenshot status
GET	`/screenshot/list`	Get information about screenshots
GET	`/screenshot/multiple`	Request multiple screenshots
GET	`/screenshot/search`	Search for screenshots
GET	`/screenshot/share`	Share a screenshot
GET	`/screenshot/thumbnail`	Retrieve a thumbnail image