Skip to main content
Websyt
Get Started

API Documentation

Integrate Websyt's comprehensive website analysis into your applications. Available on RapidAPI marketplace with credit-based pricing: Basic (0.5 credits), Standard (1 credit), and Premium reports (2 credits).

Authentication

Secure API key authentication for all requests

RESTful API

Standard HTTP methods and JSON responses

Rate Limiting

Fair usage policies to ensure service availability

SDKs Available

JavaScript, Python, PHP, and more coming soon

Available Endpoints

POST/api/v1/analyze

Analyze a website with three report types: Basic (0.5 credits), Standard (1 credit), Premium (2 credits)

Request body: { "url": "https://example.com", "reportType": "basic|standard|premium" }
Returns: Analysis ID for retrieving results
Cost: Basic: 0.5 credits, Standard: 1 credit, Premium: 2 credits
GET/api/v1/results/{id}

Retrieve analysis results by ID

Returns: Full analysis data including scores, recommendations, and performance metrics
GET/api/v1/reports/{id}/pdf

Download analysis report as PDF

GET/api/v1/account/usage

Check your API usage and remaining credits

Returns: Current usage, monthly limits, and reset date information

Quick Start Example

# Analyze a website (Basic report - 0.5 credits)
curl -X POST https://websyt.dev/api/v1/analyze \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com", "reportType": "basic"}'
# Response
{ "success": true, "data": { "id": "123", "url": "https://example.com", "scores": { "seo": 85, "performance": 92, "design": 78, "technical": 88, "overall": 86 }, "status": "completed", "timestamp": "2025-01-22T21:08:00Z", "analysisData": { ... } } }
# Get analysis results
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://websyt.dev/api/v1/results/123
# Download PDF report
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://websyt.dev/api/v1/reports/123/pdf
# Check usage and remaining credits
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://websyt.dev/api/v1/account/usage

Credit-Based Pricing

Basic Reports

0.5
credits per analysis
  • • Core SEO & Performance metrics
  • • Essential recommendations
  • • Basic technical analysis

Standard Reports

1
credit per analysis
  • • Everything in Basic
  • • Enhanced PageSpeed insights
  • • Visual analysis with AI
  • • Sitemap & robots.txt check

Premium Reports

2
credits per analysis
  • • Everything in Standard
  • • Done-for-you solutions
  • • Copy-paste HTML/CSS code
  • • Advanced technical audit

Credit Purchase Options

1 Credit
$7.00
5 Credits
$25.00
$5.00 each
20 Credits
$80.00
$4.00 each
100 Credits
$300.00
$3.00 each

Live API Testing

Test the API endpoints directly from this page. You'll need a valid API key to use the live testing interface.

🚀 Now Available on RapidAPI

Why Use RapidAPI?

  • ✅ Unified API management
  • ✅ Consolidated billing
  • ✅ Built-in monitoring & analytics
  • ✅ Standard authentication
  • ✅ Auto-generated SDKs

Quick Integration

# Via RapidAPI
curl -X POST \
https://websyt.p.rapidapi.com/analyze \
-H "X-RapidAPI-Key: YOUR_KEY" \
-d '{"url": "https://example.com"}'
View on RapidAPI →

API Plans & Pricing

API access uses the same credits as the web app — buy a pack, spend on API or UI calls. No separate API subscription.

1 Credit
$7
Pay as you go
Buy Credits
5 Credits
$25
29% bulk discount
$5.00 each
Buy Credits
Popular
20 Credits
$80
43% bulk discount
$4.00 each
Buy Credits
100 Credits
$300
57% bulk discount
$3.00 each
Buy Credits

Ready to Integrate?

The API is fully functional and ready for integration. Available directly or through RapidAPI marketplace. Start building amazing applications with Websyt's powerful website analysis capabilities.

Get API on RapidAPIDirect IntegrationView Pricing