API Reference

FastWebScraper API provides endpoints for creating scrape jobs, checking job status, and retrieving scraped content.

Checking API key...

Interactive Documentation: Try the API directly in our Swagger UI documentation.

Base URL

https://api.fastwebscraper.com/api/v1

Authentication

All API requests require authentication using an API key in the X-API-Key header:

X-API-Key: YOUR_API_KEY

Endpoints

POST /scrape/async

Create an asynchronous scrape job.

Request Body Example

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

Response Example

{
  "success": true,
  "data": {
    "jobId": "clx1234567890abcdef"
  },
  "meta": {
    "jobId": "clx1234567890abcdef",
    "queued": true
  }
}

POST /scrape/sync

Create a synchronous scrape job and wait for completion.

Same request body as POST /scrape/async, but waits for job completion before returning.

Response Example

{
  "success": true,
  "data": {
    "jobId": "clx1234567890abcdef",
    "result": {
      "success": true,
      "jobId": "clx1234567890abcdef",
      "duration": 1234,
      "statusCode": 200,
      "html": "<html><head><title>Example</title></head><body>...</body></html>"
    }
  },
  "meta": {
    "jobId": "clx1234567890abcdef",
    "durationMs": 1234,
    "creditsUsed": 1
  }
}

GET /jobs/:id

Get the status and result of a scrape job.

Parameters

id (path parameter, required) - Job ID returned from POST /scrape/async

Response Example

{
  "success": true,
  "data": {
    "id": "clx1234567890abcdef",
    "url": "https://example.com",
    "status": "COMPLETED",
    "method": "HTTP",
    "modeUsed": "http",
    "createdAt": "2026-01-23T12:00:00Z",
    "updatedAt": "2026-01-23T12:00:01Z",
    "completedAt": "2026-01-23T12:00:01Z",
    "scrapeDuration": 1234,
    "responseStatus": 200,
    "contentLength": 45678,
    "errorMessage": null,
    "html": "<html><head><title>Example</title></head><body>...</body></html>"
  }
}

GET /status

Check API status and health. No authentication required.

Response Example

{
  "success": true,
  "data": {
    "ok": true,
    "timestamp": "2026-01-23T12:00:00Z"
  }
}

Error Responses

All errors follow this format:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "retryable": false
  }
}