Screen Shot API

Take screenshots of any website in one simple API call.

Scheduling a screen shot

POST /screenshot/capture
  parameters
            url=<url> // The url of the webpage to capture. Required
        &   file_type=<png/pdf>   // optional 
        &   full_page=<false/true>  // optional 
        &   dark_mode=<false/true>  // optional 
        &   paper_size=<paper size> // optional

The above call should reurn a reponse like below

{
    "success": {
        "total": 6
    },
    "contents": {
        "id": "shot_kgNhJ0ojnHXuZaBgDNDhXQeF",
        "url": "https://theysaidso.com",
        "status": "Accepted",
        "server_time_now": "2025-03-11T19:25:21.686557Z",
        "check_back_at": "2025-03-11T19:30:21.686563Z",
        "check_back_seconds": 300
    },
    "copyright": {
        "url": "api.interfaces.one",
        "year": "2025"
    }
}

Check the status of the screen capture

GET /screenshot/status ?
   parameters 
                id=<shot_Cuif1HCy12KgRWZyW7VgUgeF>

The above call will return a result like the following

{
    "success": {
        "total": 1
    },
    "contents": [
        {
            "id": "shot_Cuif1HCy12KgRWZyW7VgUgeF",
            "status": "Success",
            "screen_shots": [
                "JVBERi0xL...",
                "JVBERi0xL...",
            ], // base64 encoded files as an array
            "server_time_now": "2025-03-11T19:30:02.707089Z",
            "report_expires_at": "2025-03-11T19:35:02.707101Z"
        }
    ],
    "copyright": {
        "url": "api.interfaces.one",
        "year": "2025"
    }
}

Ratelimiting

Some of our API calls may be public(requires free API key) , while others requires paid subscription. To maintain our serice levels both public and private API endpoints are ratelimited. Please consult your specific plan that you subscribed to for the rate limit details.

Authentication

Currently we support API Key based authentication. Please set your Autorization Bearer request header with value of your API key. Alternatively you can also pass api_key= as a request parameter, though we strongly discourage this mode of passing the key, since it will allow others to see your key.

In curl this would mean sending the Authorization header like below.

            
 curl -i <url> -H "Authorization: Bearer <api_key>"
            
            

If you are using PHP.

            
$authorization = "Authorization: Bearer <api_key>";
$ch = curl_init('<url>'); // Initialise cURL
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json' , $authorization ));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); // OR GET
$result = curl_exec($ch);
curl_close($ch);
            
            

In javascript you can use headers key to add the authorization header

            
$.ajax({
   url: '<url>'
   type: 'GET',
   contentType: 'application/json'
   headers: {
      'Authorization': 'Bearer <api_key>'
   },
   success: function (result) {
       // CallBack(result);
   },
   error: function (error) {

   }
});