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

ParameterTypeRequiredDefaultDescription
api_keystringYes-The API key to use for the request
urlstringYes-The URL of the webpage to capture
widthnumberNo1920Viewport width in pixels
heightnumberNo1080Viewport height in pixels
fullpagebooleanNo-Capture full scrollable page
devicestringNo-Preset mobile device:(iphone, iphonepro, pixel, galaxy, ipadpro). Note when a device is set, the width and height will be ignored.
formatstringNopngImage format (png, jpeg, or webp)
qualitynumberNo80Image 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

ParameterTypeRequiredDefaultDescription
api_keystringYes-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"
    }
}
© 2025 TakeScreen. All rights reserved.TakeScreen