PageGuard API Docs

const API_KEY = 'pg_xxx...';

async function scanSite(url) {
  // 1. Submit scan
  const res = await fetch('https://pageguard.org/api/v1/scan', {
    method: 'POST',
    headers: { 'X-API-Key': API_KEY, 'Content-Type': 'application/json' },
    body: JSON.stringify({ url }),
  });
  const { scan_id } = await res.json();

  // 2. Poll until complete (~30s)
  while (true) {
    await new Promise(r => setTimeout(r, 4000));
    const poll = await fetch(`https://pageguard.org/api/v1/scan/${scan_id}`, {
      headers: { 'X-API-Key': API_KEY },
    });
    const data = await poll.json();
    if (data.status === 'complete') return data;
  }
}

const result = await scanSite('https://example.com');
console.log(result.scores);            // { performance: 0.91, accessibility: 0.95, ... }
console.log(result.ai_report);         // "Your site scores well..."
console.log(result.compliance_record); // true ← logged to your compliance record

import time, requests

API_KEY = 'pg_xxx...'
BASE = 'https://pageguard.org'

def scan_site(url: str) -> dict:
    # 1. Submit scan
    r = requests.post(
        f'{BASE}/api/v1/scan',
        headers={'X-API-Key': API_KEY, 'Content-Type': 'application/json'},
        json={'url': url},
    )
    scan_id = r.json()['scan_id']

    # 2. Poll until complete (~30s)
    while True:
        time.sleep(4)
        poll = requests.get(
            f'{BASE}/api/v1/scan/{scan_id}',
            headers={'X-API-Key': API_KEY},
        )
        data = poll.json()
        if data['status'] == 'complete':
            return data

result = scan_site('https://example.com')
print(result['scores'])            # {'performance': 0.91, 'accessibility': 0.95, ...}
print(result['ai_report'])         # 'Your site scores well...'
print(result['compliance_record']) # True ← logged to your compliance record

# 1. Submit scan
SCAN=$(curl -sX POST https://pageguard.org/api/v1/scan \
  -H 'X-API-Key: pg_xxx...' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com"}')

SCAN_ID=$(echo $SCAN | jq -r '.scan_id')

# 2. Poll until complete
while true; do
  sleep 4
  RESULT=$(curl -s https://pageguard.org/api/v1/scan/$SCAN_ID -H 'X-API-Key: pg_xxx...')
  STATUS=$(echo $RESULT | jq -r '.status')
  if [ "$STATUS" = "complete" ]; then
    echo $RESULT | jq '.scores, .compliance_record'
    break
  fi
done