Skip to content
Kritano Docs
Menu

Using the API

Scans

Score one public page without adding it as a site.

A scan loads one public page, runs every audit rule on it and scores it, without adding a site to your account. It's for checking any address quickly: an "audit your site" box on your own website, say, or a check in a deploy pipeline. Scans need the scans:run scope.

curl -X POST https://app.kritano.com/api/v1/scans \
  -H "Authorization: Bearer $KRITANO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/pricing"}'

The scan runs in the background, usually in 5 to 20 seconds. Poll GET /scans/{id} until status is completed or failed. A completed scan has result: the final URL after redirects, the HTTP status, an overall score, a score per category and the findings, worst first.

Good to know

  • One page only. For a whole site, its history and its fix plan, start an audit instead.

  • Repeats are free. A scan of the same URL in the last hour is returned (status 200, not 201) instead of loading the page again, and doesn't count towards your daily scans.

  • Public pages only. Addresses must be public hostnames: no IP addresses, localhost or .local names. The page is loaded politely, at most one request every few seconds to a site, and robots.txt is honoured.

  • Limits: see Rate limits for scans a day.