API Documentation

Programmatic access to the Website Security Exposure Scanner.

Authentication

Requests require an API key sent via the Authorization header.

Authorization: Bearer <your-api-key>

Contact the administrator to obtain an API key.

Endpoints

POST/api/v1/scan

Description

Scan a website for security exposures. Returns findings, technologies detected, and a risk score.

Request Body

{
  "url": "https://example.com"
}

Response (200)

{
  "success": true,
  "target": "https://example.com",
  "scanDate": "2026-07-27T...",
  "technologies": [...],
  "findings": [...],
  "summary": {
    "critical": 0,
    "high": 1,
    "medium": 3,
    "low": 5,
    "info": 8,
    "pass": 27,
    "total": 44
  },
  "score": 82
}

Rate Limits

30 requests per minute per IP.

cURL Example

curl -X POST https://openseosecuritytools.vercel.app/api/v1/scan \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <api_key>" \
  -d '{"url": "https://example.com"}'

JavaScript Example

const response = await fetch("https://openseosecuritytools.vercel.app/api/v1/scan", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <api_key>"
  },
  body: JSON.stringify({ url: "https://example.com" })
});

const data = await response.json();
console.log(data.score);
console.log(data.findings);