Skip to main content
GET
/
web
/
scrape
/
images
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.webScrapeImages({ url: 'https://example.com' });

console.log(response.images);
{
  "success": true,
  "images": [
    {
      "src": "<string>",
      "element": "img",
      "type": "url",
      "alt": "<string>"
    }
  ],
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

url
string<uri>
required

Full URL to scrape images from (must include http:// or https:// protocol)

Response

Successful response

success
enum<boolean>
required

Indicates success

Available options:
true
images
object[]
required

Array of scraped images

url
string
required

The URL that was scraped