API reference

POST /api/v1/scan

Run all nine exposure checks on any link page from your own code, and read the score and each result.

#Request

JSON body with one field. Twenty scans an hour per key.

curl -X POST https://peekin.bio/api/v1/scan \
  -H "Authorization: Bearer pk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://linktr.ee/somebody"}'

#Response

{
  "ok": true,
  "url": "https://linktr.ee/somebody",
  "score": 47,
  "checks": [
    { "id": "destination", "label": "Can anyone read your paid link off this page?",
      "pass": false, "weight": 30,
      "detail": "Anyone can read this off the page: https://onlyfans.com/..." },
    { "id": "consistent", "label": "Does this page show a robot something different?",
      "pass": true, "weight": 15, "detail": "A crawler and a phone get the same page." }
  ],
  "exposed": ["https://onlyfans.com/..."]
}

Field	Meaning
`score`	0 to 100, what is left after the failed checks
`checks[]`	The nine checks. `id`, the question as `label`, `pass`, `weight`, and a `detail` line in words
`exposed[]`	Every paid address the page gave away, if any

The ids are listed in The exposure scanner. A page we could not fetch at all returns ok: false and a reason.