Skip to main content
GET
Enrich a URL

Overview

/enrich is the most comprehensive endpoint. It runs brand extraction, company info extraction, and website classification in parallel and returns all results in a single response. This is equivalent to calling /brand + /company + /classify together, but more efficient because the page is only loaded once. Use /enrich when you want a complete profile of a domain.

Cost comparison

Example request

Example response

All parameters

/enrich accepts the same parameters as /brand for controlling color extraction and screenshot settings:

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.

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.

filterAchromatic
boolean
default:false

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

Response

Enrichment result.

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

Combined output from brand, company, and classify extraction.

meta
object
required