Documentation
    Amazon Web Services
    Microsoft Azure
    RapidAPI
    APILayer
Last Update: 2024-03-01

Website Screenshot API


Table of Content


Subscribe on AWS Marketplace
Code samples
API endpoint: Screenshot
Troubleshooting

Subscribe on AWS Marketplace


Navigate to our product listing on the AWS Marketplace. Select the "View purchase options" button to proceed.

On the following page, click the "Subscribe" button to initiate the subscription process.

After subscribing, you will need to set up your account on our platform. Do this by clicking the "Set up your account" link provided.

You will be directed to the registration page. Here, fill in your account details in the provided fields. Once you have entered all necessary information, click the 'Subscribe' button to proceed.

Upon successful registration, your unique API key will be displayed. It is crucial to store this key in a secure location for future use.

Code samples


The following documentation page outlines how to use the API endpoint to capture a screenshot of a webpage at https://www.silverlining.cloud. Replace <YourApiKey> with the actual API Key you received during the sign-up process:

var client = new RestClient("https://aws-screenshot.silverlining.cloud/screenshot");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<YourApiKey>");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@"    ""url"": ""https://silverlining.cloud""" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
API endpoint: /screenshot


URL endpoint: https://aws-screenshot.silverlining.cloud/screenshot


Method: POST


"header": {
  "x-api-key": STRING,
  "Content-Type": "application/json"
}


"body": {
  "url": STRING,
  "wait": NUMBER,
  "full_page": BOOLEAN,
  "browser_size": STRING,
  "execute_js": STRING
}



Required

"url": The URL of the webpage for which you want to capture a screenshot. Include the protocol (http, https).

 
Optional

"wait": Specify the number of seconds to wait before capturing the screenshot. This can be useful for waiting for lazy-loading elements. The value must be between 1 and 10 seconds. The default is 0.

 "full_page": Set to true if you want to capture a screenshot of the entire page instead of just the viewport. The default is false.

"browser_size": Define the browser size for the screenshot. The default is "1920x1080".

"execute_js": Provide JavaScript code to execute before capturing the screenshot. The default is an empty string.

Response:


"body": {
  "screenshot_url": STRING,
  "input_data":{
    "url": STRING,
    "wait": NUMBER,
    "full_page": BOOLEAN,
    "browser_size": STRING,
    "bypass_scraping_detection": BOOLEAN,
    "execute_js": STRING
   }
}

"screenshot_url": The API response will provide a link to the captured screenshot. The screenshot will be stored for one year, allowing you to access and utilize it as needed during that time.

Troubleshooting

"message": "Invalid Input: The request contains incorrectly formatted parameters"

This error message means that the body parameters you have passed are malformed. Please follow the instructions given in the endpoint descriptions. Common issues include forgetting to add a comma (',') after every parameter line or missing a parenthesis somewhere.

"message": "Endpoint request timed out"

You receive this error message when the code execution exceeds the maximum timeout (usually 29 seconds).