GET
/
brand
/
screenshot
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

Response

200
application/json

Successful response

The response is of type object.