Skip to main content
GET
Extract fonts
5 credits See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Query Parameters

directUrl
string<uri>

Exact page to inspect. Provide either domain or directUrl.

domain
string

Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated. You must provide either 'domain' or 'directUrl', but not both.

Minimum string length: 3
maxAgeMs
integer | null
default:7776000000

Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 year. 0 refreshes.

timeoutOpts
object

Request deadline and what to return when it passes.

tags
string[]

Comma-separated labels for filtering usage, e.g. production,team-alpha. Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

status
string
required

Always ok on success.

domain
string
required

The normalized domain that was processed

fonts
object[]
required

Array of font usage information

code
integer
required

HTTP status code, e.g., 200

cache_metadata
object
required

Whether this response came from cache.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

finalDOMState
enum<string>

loaded, or still-loading when capture ended before the page finished loading.

Available options:
loaded,
still-loading

Available font files keyed by family name. Omitted when no downloadable fonts are found.

key_metadata
object

Credits this request used and your remaining balance.