squirrelscan API

REST detected 2026-07-04

Details

URL: https://api.squirrelscan.com
Spec: https://squirrelscan.com/openapi.json
Docs: https://docs.squirrelscan.com/api

Authentication

squirrelscan org API key + squirrelscan org API key Authorization: Bearer <credential> discovered

squirrelscan org API key api_key Get key ↗

Create a key in Settings → API Keys, or run `squirrel auth login` and then `squirrel keys create`. Pick scopes and expiry, copy the key when shown (it is shown once), then supply it as Authorization: Bearer sq_... or set SQUIRRELSCAN_API_KEY for CLI/headless use. The legacy env alias SQUIRREL_API_TOKEN is also accepted by the CLI.

squirrelscan CLI login token bearer discovered

Authorization: Bearer <credential>

Run `squirrel auth login`. The CLI opens a browser/device authorization flow, signs you in, and stores a user-scoped sqcli_... login session for interactive cloud features. This token is best for local development; for automation use an org API key instead.

squirrelscan API key api_key declared Get key ↗

Authorization: Bearer <credential>

Create a key at https://app.squirrelscan.com/settings/api-keys (or run squirrel keys create after squirrel auth login). Set it as SQUIRRELSCAN_API_KEY, or send it as Authorization: Bearer sq_... on any request. Local, unauthenticated audits are always free; a key is only needed for cloud features such as hosted crawling, publishing, and credits.