Documentation
API Documentation
Learn how to integrate TakeScreen into your application with our simple REST API.
Screenshot API
Example Request
curl -X GET "https://takescreen.app/api/takescreenshot?api_key=YOURKEYHERE&url=https://example.com&fullpage=true"Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| api_key | string | Yes | - | The API key to use for the request |
| url | string | Yes | - | The URL of the webpage to capture |
| width | number | No | 1920 | Viewport width in pixels |
| height | number | No | 1080 | Viewport height in pixels |
| fullpage | boolean | No | - | Capture full scrollable page |
| device | string | No | - | Preset mobile device:(iphone, iphonepro, pixel, galaxy, ipadpro). Note when a device is set, the width and height will be ignored. |
| format | string | No | png | Image format (png, jpeg, or webp) |
| quality | number | No | 80 | Image quality (1-100, only for jpeg/webp) |
Response Format
The API returns a JSON response with the following structure:
{
"success": true,
"screenshot_url": "https://takescreen.s3.eu-north-1.amazonaws.com/screenshot-......",
"original_url": "https://www.example.com"
}Plan API
The Plan API allows you to check your current plan details, including usage limits and remaining credits.
Example Request
curl -X GET "https://takescreen.app/api/plan?api_key=YOURKEYHERE"Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| api_key | string | Yes | - | Your API key |
Response Format
The API returns a JSON response with the following structure:
{
"success": true,
"plan": {
"name": "Pro",
"monthly_limit": 10000,
"remaining_credits": 8500,
"reset_date": "2024-03-01T00:00:00Z"
}
}