Skip to main content
GET
Extract brand assets
Returns a site’s brand assets under data.brand. Parameters are camelCase, like screenshotColors. 10 credits. Failed requests are never charged.

Guide: Brand

Every color option, design tokens, the response fields and examples.

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Query Parameters

url
string
required

The website URL to process. https:// is prepended automatically if no protocol is provided.

Example:

"https://stripe.com"

screenshotColors
integer

Extract N dominant colors from the page screenshot. Range: 2–12. Omit to skip screenshot color extraction.

Required range: 2 <= x <= 12
css
boolean
default:false

Extract colors from linked CSS files. Pass true to enable.

html
boolean
default:false

Extract colors from inline HTML. Pass true to enable.

javascript
boolean
default:false

Extract colors from linked JS files. Pass true to enable.

screenshotWidth
integer
default:1440

Viewport width in pixels. Range: 320–3000. Default: 1440.

Required range: 320 <= x <= 3000
screenshotHeight
integer
default:900

Viewport height in pixels. Range: 320–3000. Default: 900.

Required range: 320 <= x <= 3000
screenshotFormat
enum<string>
default:jpeg

Screenshot format. Default: jpeg.

Available options:
jpeg,
png,
pdf
screenshotFullPage
boolean
default:false

Capture the full scrollable page. Pass true to enable.

disableAdblocker
boolean
default:false

Disable the built-in adblocker. Pass true to enable (useful for sites that detect ad blockers).

filterAchromatic
boolean
default:false

Exclude near-white, near-black, and greyscale colors from results. Pass true to enable.

designTokens
boolean
default:false

Add brand.design_tokens: the site's colors by role (primary, background, text, heading, link), its heading and body type, and its button and input styles, read from the rendered page. Pass true to enable. Requests with this set are never answered from curated data.

Response

Brand extraction result.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required