---
title: "Extract a website styleguide"
method: GET
path: "/data/web/styleguide"
tags: ["Data APIs"]
---

# Extract a website styleguide

`GET /data/web/styleguide`

## Request

- Base URL: `https://api.notte.cc` (the document declares no server; this is the origin it was published from)
- URL: `https://api.notte.cc/data/web/styleguide`
- Auth: OAuth 2
  - Password
  - Token URL: `token`

## Query parameters

- `domain` string, nullable
- `directUrl` string, nullable
- `maxAgeMs` integer, nullable
- `colorScheme` string
- `timeoutOpts[milliseconds]` integer, nullable
- `timeoutOpts[behavior]` string
- `zdr` string
- `tags` string, nullable

## Headers

- `X-Notte-Cache-Mode` string, nullable: Extraction cache: default, refresh, or bypass.
- `X-Notte-Cache-Max-Age-Ms` string, nullable: Maximum cached result age in milliseconds; zero forces refresh.
- `X-Notte-Cache-Ttl-Seconds` string, nullable: Shorten the server storage TTL; zero bypasses caching.
- `x-notte-request-origin` string, nullable
- `x-notte-sdk-version` string, nullable

## Response `200`

Successful Response

- StyleguideResponse
  - `status` 'ok', required
  - `domain` string, required
  - `styleguide` Styleguide, required
    - `mode` 'light' | 'dark', required
    - `colors` Colors, required
      - `accent` string, required
      - `background` string, required
      - `text` string, required
    - `typography` Typography, required
      - `headings` HeadingStyles, required
        - `h1` TypographyStyle
          - `fontFamily` string, required
          - `fontFallbacks` string[], required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `lineHeight` string, required
          - `letterSpacing` string, required
        - `h2` TypographyStyle
          - `fontFamily` string, required
          - `fontFallbacks` string[], required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `lineHeight` string, required
          - `letterSpacing` string, required
        - `h3` TypographyStyle
          - `fontFamily` string, required
          - `fontFallbacks` string[], required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `lineHeight` string, required
          - `letterSpacing` string, required
        - `h4` TypographyStyle
          - `fontFamily` string, required
          - `fontFallbacks` string[], required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `lineHeight` string, required
          - `letterSpacing` string, required
      - `p` TypographyStyle
        - `fontFamily` string, required
        - `fontFallbacks` string[], required
        - `fontSize` string, required
        - `fontWeight` number, required
        - `lineHeight` string, required
        - `letterSpacing` string, required
    - `elementSpacing` Spacing, required
      - `xs` string, required
      - `sm` string, required
      - `md` string, required
      - `lg` string, required
      - `xl` string, required
    - `shadows` Shadows, required
      - `sm` string, required
      - `md` string, required
      - `lg` string, required
      - `xl` string, required
      - `inner` string, required
    - `fontLinks` object, required
    - `components` Components, required
      - `button` ButtonStyles, required
        - `primary` ButtonStyle
          - `backgroundColor` string, required
          - `color` string, required
          - `borderColor` string, required
          - `borderRadius` string, required
          - `borderWidth` string, required
          - `borderStyle` string, required
          - `padding` string, required
          - `minWidth` string, required
          - `minHeight` string, required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `fontFamily` string, nullable
          - `fontFallbacks` string[], nullable
          - `textDecoration` string, required
          - `textDecorationColor` string, nullable
          - `boxShadow` string, required
          - `css` string, required
        - `secondary` ButtonStyle
          - `backgroundColor` string, required
          - `color` string, required
          - `borderColor` string, required
          - `borderRadius` string, required
          - `borderWidth` string, required
          - `borderStyle` string, required
          - `padding` string, required
          - `minWidth` string, required
          - `minHeight` string, required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `fontFamily` string, nullable
          - `fontFallbacks` string[], nullable
          - `textDecoration` string, required
          - `textDecorationColor` string, nullable
          - `boxShadow` string, required
          - `css` string, required
        - `link` ButtonStyle
          - `backgroundColor` string, required
          - `color` string, required
          - `borderColor` string, required
          - `borderRadius` string, required
          - `borderWidth` string, required
          - `borderStyle` string, required
          - `padding` string, required
          - `minWidth` string, required
          - `minHeight` string, required
          - `fontSize` string, required
          - `fontWeight` number, required
          - `fontFamily` string, nullable
          - `fontFallbacks` string[], nullable
          - `textDecoration` string, required
          - `textDecorationColor` string, nullable
          - `boxShadow` string, required
          - `css` string, required
      - `card` CardStyle
        - `backgroundColor` string, required
        - `borderColor` string, required
        - `borderRadius` string, required
        - `borderWidth` string, required
        - `borderStyle` string, required
        - `padding` string, required
        - `boxShadow` string, required
        - `textColor` string, required
        - `css` string, required
  - `code` integer, required
  - `finalDOMState` 'loaded' | 'still-loading', required
  - `cache_metadata` StyleguideCacheMetadata, required
    - `status` 'hit' | 'miss'
    - `age_ms` integer
  - `request_id` string, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-18** `20f8ac8dc733`: 1 breaking, 2 warning, 3 info
  - the `status` response property const value `miss` was removed for the status `200`
  - added the new `hit` enum value to the `cache_metadata/status` response property for the response status `200`
  - added the new `miss` enum value to the `cache_metadata/status` response property for the response status `200`
  - added the new optional `header` request parameter `X-Notte-Cache-Max-Age-Ms`
  - …2 more
- **2026-10-16** `24d67222f012`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/notte/apis/notte-api/changes/data/web/styleguide/get.md)

---

[API](https://skmtc.dev/notte/apis/notte-api.md) - [All operations](https://skmtc.dev/notte/apis/notte-api/llms.txt) - [OpenAPI document](https://skmtc.dev/notte/apis/notte-api/revisions/d56fcbf39bc9?raw)