ScrapeCompass API Documentation

1. GET /v1/data

Fetch raw HTML or processed data from the specified target URL. You can also pass query parameters to specify the format (e.g., JSON, CSV).

• url - The webpage you want to scrape (encoded).
• format - Optional. Defaults to JSON.

Example:
GET /v1/data?url=https%3A%2F%2Fwww.example.com&format=json
Authorization: Bearer YOUR_API_KEY

Response (JSON):
{
  "status": "success",
  "data": "...Example.com content..."
}
    

2. POST /v1/extract

Submit a more advanced extraction request with custom CSS or XPath selectors. Ideal for structured data output (e.g., for e-commerce product details).

Request Body Fields:

• url - The target webpage URL.
• selectors - An array of CSS or XPath selectors.
• format - Output format (JSON/CSV).

Example cURL:

curl -X POST "https://api.ScrapeCompass.com/v1/extract" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{
       "url": "https://www.example.com/product/123",
       "selectors": ["#title", ".price", ".description"],
       "format": "json"
     }'

Response:
{
  "status": "success",
  "extracted_data": {
    "title": "Example Product Title",
    "price": "$19.99",
    "description": "A short product description..."
  }
}
    

3. GET /v1/status

Retrieve your account usage stats, remaining API calls, concurrency limits, and service health info.

GET /v1/status
Authorization: Bearer YOUR_API_KEY

Response:
{
  "status": "success",
  "account": {
    "api_calls_used": 2000,
    "api_calls_limit": 10000,
    "concurrent_requests": 2
  },
  "service_health": {
    "uptime_percent": "99.95%",
    "last_incident": "2023-06-15"
  }
}