Skip to main content
GET
Read a company's design system

Authorizations

X-API-Key
string
header
required

Query Parameters

domain
string

Domain to read the design system from, using its homepage. Send this or url.

Example:

"stripe.com"

url
string

One page to read instead of the homepage, for a section styled differently from the rest of the site. Send this or domain.

Example:

"https://stripe.com/pricing"

maxAge
number

Accept a stored result no older than this many milliseconds. 0 reads the page fresh. Defaults to 30 days for a domain and 7 days for a page.

Example:

0

Response

The design system.

data
object | null
required

Null when the domain could not be rendered. An unresolved domain is free.