REST API Reference

Authorization: Bearer peak_<your_api_key>

https://www.peakvisibility.io/api

const TOKEN = process.env.PEAK_API_TOKEN  // peak_...
const BASE  = 'https://www.peakvisibility.io/api'

const headers = {
  'Authorization': `Bearer ${TOKEN}`,
  'Content-Type':  'application/json',
}

// 1. Start the scan
const start = await fetch(`${BASE}/scan`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ url: 'https://example.com' }),
})
const { id } = await start.json()
console.log('Scan started:', id)

// 2. Poll until complete
let status = 'processing'
while (status === 'processing' || status === 'queued') {
  await new Promise(r => setTimeout(r, 4000))
  const poll = await fetch(`${BASE}/scan-status?id=${id}`, { headers })
  const data = await poll.json()
  status = data.status
  console.log(`[${data.step}] ${data.message} — ${data.pageCount} pages`)
}

if (status !== 'complete') throw new Error(`Scan failed: ${status}`)

// 3. Download the ZIP
const dl = await fetch(`${BASE}/scan-download?id=${id}`, { headers })
const { url, filename } = await dl.json()

const zip = await fetch(url)
const buf = await zip.arrayBuffer()
require('fs').writeFileSync(filename, Buffer.from(buf))
console.log('Saved:', filename)