Generate an embeddable verification badge
get_badge_embedProduce the HTML (and Markdown) for a badge the site owner can paste into their footer or README. It renders a live SVG showing a real measured score that refreshes every six hours and links through to the full audit, so a visitor can verify it. Use this when someone wants to display that their site was checked.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The website to inspect. A bare domain works — "example.com" is treated as https://example.com. | |
| style | No | Badge shape. score shows the number, verified shows a tick and wordmark, shield is the flat two-part style used by build badges, compact is the smallest. | score |
| theme | No | Colour scheme to match the page it will sit on. | light |
| metric | No | Which score the badge displays. Use overall unless the site wants to highlight one category. | overall |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | ||
| html | Yes | Ready-to-paste anchor and image markup. | |
| linkUrl | No | Full report the badge links to, so a visitor can verify the score. | |
| imageUrl | Yes | Live SVG badge; re-renders from a real audit every six hours. | |
| markdown | No | The same badge for a README. |