Skip to main content

API Reference Overview

BoltShot provides a RESTful API for capturing screenshots of websites. This section provides an overview of the screenshot endpoint.

Base URL​

https://api.boltshot.dev/capture

Request Format​

HTTP Method​

The screenshot API uses GET requests with query parameters.

Authentication​

Pass your API key as a query parameter:

?apiKey=your_api_key_here

Alternatively, you can pass the API key in the X-API-Key header. See Authentication for details.

Response Format​

Success Responses​

200 OK - Successful screenshot request

Binary Response (default):

  • Content-Type: image/png, image/webp, or application/pdf
  • Body: Binary file data

JSON Response (when returnFile=false):

{
  "success": true,
  "data": {
    "requestId": "uuid",
    "fileName": "screenshot.png",
    "processingTime": 2500,
    "fileSize": 1024000,
    "url": "https://storage.example.com/screenshots/screenshot.png",
    "imageData": "data:image/png;base64,..."
  }
}

Error Responses​

All errors follow this standardized format:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": "Additional error details (optional, can be string, array, or object)"
  }
}

See Errors for detailed error codes and examples.

Rate Limiting​

BoltShot implements rate limiting for screenshot requests:

  • Screenshots: 40 requests per minute per IP

Rate limit headers are included in responses:

X-RateLimit-Limit: 40
X-RateLimit-Remaining: 39
X-RateLimit-Reset: 1633024800

When rate limited, you'll receive a 429 Too Many Requests response.

Endpoint​

Screenshot Endpoint​

The screenshot endpoint accepts GET requests:

MethodEndpointDescriptionAuth Required
GET/captureCreate screenshotYes (API Key)

Example:

GET https://api.boltshot.dev/capture?url=https://example.com&apiKey=your_api_key_here

For detailed parameter documentation, see Screenshot API.

Next Steps​