Skip to main content
GET
/
brand
/
screenshot
JavaScript
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});

const response = await client.brand.screenshot({ domain: 'domain' });

console.log(response.code);
{
  "status": "<string>",
  "domain": "<string>",
  "screenshot": "<string>",
  "screenshotType": "viewport",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
domain
string
required

Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.

​
fullScreenshot
enum<string>

Optional parameter to determine screenshot type. If 'true', takes a full page screenshot capturing all content. If 'false' or not provided, takes a viewport screenshot (standard browser view).

Available options:
true,
false
​
page
enum<string>

Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain's links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page.

Available options:
login,
signup,
blog,
careers,
pricing,
terms,
privacy,
contact
​
prioritize
enum<string>

Optional parameter to prioritize screenshot capture. If 'speed', optimizes for faster capture with basic quality. If 'quality', optimizes for higher quality with longer wait times. Defaults to 'quality' if not provided.

Available options:
speed,
quality

Response

Successful response

​
status
string

Status of the response, e.g., 'ok'

​
domain
string

The normalized domain that was processed

​
screenshot
string

Public URL of the uploaded screenshot image

​
screenshotType
enum<string>

Type of screenshot that was captured

Available options:
viewport,
fullPage
​
code
integer

HTTP status code