Website Screenshot API
Table of Content
Subscribe on AWS Marketplace
Code samples
API endpoint: Screenshot
API Usage Dashboard & API Key Retrival
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 Playground
This API Playground for our Website Screenshot API allows you to experience the service in real-time. Simply provide a website URL, along with optional parameters, and receive a direct link to the captured screenshot from the API. Whether you’re integrating screenshots into your application, creating a visual archive, or just testing out the service, the playground offers an easy-to-use interface to view real-time responses instantly.
"To see the result, please send a request to the API."
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,
"html": STRING,
"wait": NUMBER,
"full_page": BOOLEAN,
"browser_size": STRING,
"proxy_country_code": STRING,
"custom_headers": STRING
"execute_js": STRING,
"screenshot_element": STRING,
"screenshot_crop_box": STRING,
"return_as_file": BOOLEAN,
"return_as_pdf": BOOLEAN
}
Required
"url": The URL of the webpage for which you want to capture a screenshot. Include the protocol (http, https).
or "html": The HTML of the website you want to capture.
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.
"proxy_country_code": Specifies the ISO 3166-1 alpha-2 code (e.g., "US") to route traffic through a specific country, incurring a cost of 3 API credits per request instead of the standard 1.
"custom_headers": Accepts a dictionary of HTTP headers to inject or override in the request, allowing you to manually set fields like User-Agent, Referer, or Cookie.
"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.
"screenshot_element": Specify the website element using XPath syntax (e.g., '//header') for which the screenshot should be taken, instead of capturing the entire browser viewport.
"screenshot_crop_box": Define a box to crop the taken screenshot by providing X and Y coordinates along with the width and height of the box. The format should be "X, Y, width, height" (e.g., "100,200,500,400").
"return_as_file": Set to true to receive the screenshot as a base64-encoded string instead of a URL to the screenshot. The default value is false.
"return_as_pdf": Set to true to receive the screenshot in .pdf format instead of .png.
Response:
"body": {
"screenshot_url": STRING,
"input_data":{
"url": STRING,
"wait": NUMBER,
"full_page": BOOLEAN,
"browser_size": STRING,
"execute_js": STRING,
"screenshot_element": STRING,
"screenshot_crop_box": STRING,
"return_as_file": BOOLEAN
}
}"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.
API Usage Dashboard
You can monitor and review your API activity in the API Usage Dashboard at https://silverlining.cloud/dashboard. Simply log in with your email address, then verify access using the one-time password (OTP) sent to your inbox. The dashboard displays your latest 1,000 API requests directly in the browser for quick inspection. For full analytics, you can also download the complete request history as a CSV file. After clicking the download button, a secure download link will be sent to your email address.
Please note that only API requests starting from April 2025 are included.
If you need to change your account email address, contact our support team.
API Key Retrieval
If you’ve lost your API key, log in to the web dashboard (see above) and open the Settings tab. There, you’ll find all API keys for all services you’re subscribed to.
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).
How can I see my API usage and associated costs?
Navigate to our API Usage Dashboard to view past API requests. There, you can download a CSV export of all requests made.
To check the associated costs of your API usage, use the AWS Billing dashboard:
- Navigate to AWS Cost Management.
- In the left panel, select Cost Explorer.
- Use the cost filters on the right side. Under Legal entity, filter for SilverLining.Cloud.
How can I cancel my subscription?
To cancel your subscription, follow these steps:
- Go to the AWS Marketplace Console at https://aws.amazon.com/marketplace/library. Ensure that you are logged into the account that is subscribed to the product you want to cancel.
- Find the product you want to cancel and click on 'Manage.'
- Click on 'Actions' and then select 'Cancel subscription.'
For more detailed instructions, visit the AWS Marketplace Buyer Guide at https://docs.aws.amazon.com/marketplace/latest/buyerguide/cancel-subscription.html.