API Documentation

REST API for Pro users to integrate bugX tools into their workflows

Pro Feature: API access requires a Pro subscription. Get your API key from the Dashboard.

Endpoints

Base URL

All API requests should be made to the following base URL:

https://bugx.in/api/v1

Authentication

All API requests require an API key passed in the X-API-Key header.

Example Request Header
X-API-Key: wot_your_api_key_here

Getting Your API Key

  1. Sign up for a Pro account
  2. Go to your Dashboard
  3. Click "Generate New Key" in the API Key section

Check URL Status

POST /api/v1/check-status

Check HTTP status codes for multiple URLs.

Request Body

Parameter Type Description
urls required array Array of URLs to check (max 100)
concurrency number Concurrent requests (default: 5)
Example Request
curl -X POST https://bugx.in/api/v1/check-status \
  -H "X-API-Key: wot_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com",
      "https://google.com"
    ]
  }'
Example Response
{
  "success": true,
  "total": 2,
  "working": 2,
  "broken": 0,
  "results": [
    {
      "url": "https://example.com",
      "status": 200,
      "ok": true,
      "ms": 234
    }
  ]
}

Page Speed

POST /api/v1/page-speed

Measure page load times and get performance grades.

Request Body

Parameter Type Description
urls required array Array of URLs to test (max 50)
concurrency number Concurrent requests (default: 3)
Example Response
{
  "success": true,
  "total": 1,
  "avgTtfb": 245,
  "avgTotal": 892,
  "grades": { "A": 0, "B": 1, "C": 0, "D": 0, "F": 0 },
  "results": [
    {
      "url": "https://example.com",
      "ttfb": 245,
      "totalTime": 892,
      "grade": "B"
    }
  ]
}

SSL Checker

POST /api/v1/ssl-checker

Check SSL certificate validity and expiration.

Request Body

Parameter Type Description
domains required array Array of domains to check (max 50)
Example Request
{
  "domains": ["example.com", "google.com"]
}

SEO Checker

POST /api/v1/seo-checker

Analyze SEO meta tags and get optimization scores.

Request Body

Parameter Type Description
urls required array Array of URLs to analyze (max 20)

Redirect Checker

POST /api/v1/redirect-checker

Trace redirect chains and detect loops.

Request Body

Parameter Type Description
urls required array Array of URLs to check (max 50)

Security Headers

POST /api/v1/security-headers

Check security headers and get security grades.

Request Body

Parameter Type Description
urls required array Array of URLs to check (max 50)

Rate Limits

Pro users have unlimited API calls. However, each endpoint has limits on batch size:

Error Handling

Errors are returned with appropriate HTTP status codes:

Error Response Format
{
  "error": "Description of the error"
}