Taking screenshots using REST API

Published October 19, 20212 min read

Taking screenshots using REST API

Have you ever wondering if you could quickly take a screenshot of a webpage using just a single request?

Bannerly API allows you to not only create images using templates and API but also take a screenshots using REST API.

There are plenty use cases of that:

  • Post it on social media
  • Make a list of websites
  • Detect branding based on colors
  • Test or health-check your webpage
  • Read texts from screen

How to take a screenshot with API?

Generate your API key in Bannerly by signing up to the system. Get the API key from your account section and then you can make a request like below.

curl 
    --location 
    --request POST 'https://api.bannerly.io/api/v1/screenshots' \
    --header 'X-API-KEY: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "url": "https://bannerly.io"
        "width": 1366,
        "height": 768,
    }'

Bannerly API will respond after a couple of seconds with link where you can download the screenshot. Example successful response is shown below.

{
  "requestId": "ed39c85ac41f4c54b95e4caaad4ebff8",
  "href": "https://cdn.bannerly.io/.../image.png",
  "request": {
    "width": 1366,
    "height": 768,
    "url": "https://bannerly.io"
  }
}

Screenshot API parameters

As you seen above we passed url of the website, width and height of the screenshot. These parameters are required but you can add more options:

  • url (required) - website URL of which Bannerly should take a screenshot
  • height (required) - screenshot height
  • width (required) - screenshot width,
  • expires (optional) - add expiration time in seconds for the image, available values from 1 to 604800
  • waitTime (optional) - add wait time in milliseconds before taking a screenshot, available values from 500 to 5000
  • webhookUrl (optional) - send response to the given webhookUrl as POST request

Does it integrate with other tools?

Yes! Bannerly is integrated with Zapier and Make.com (Integromat). Soon we will add more integrations like n8n.io. Please also notice that every request supports a webhook. Taking a screenshot takes time because it's very resource demanding and complex process for servers. You can pass a URL in webhookUrl field, thanks to that Bannerly API will accept your request and immediately return you a response. Once Bannerly finish processing your request a new request will be sent to the given URL in webhookUrl.

Can I set an expiration date?

Yes, you can set expiration date on every screenshot from 1 second up to 7 days. Add a field expires and put there an expiration value in seconds. Bannerly API return you a link in href field which will be valid for requested period of time.


Share article

Relevant posts

How to create many images from a spreadsheet?

How to create many images from a spreadsheet?

Jakub PomykałabyJakubMarch 22, 2022

Learn how to generate many images from a template using spreadsheet data .

Read more
Image Generation with Integromat

Image Generation with Integromat

Jakub PomykałabyJakubDecember 08, 2021

Automate image generation using Make.com. Create images using your templates, or take website screenshot with Make.com.

Read more
Image Generation with Zapier

Image Generation with Zapier

Jakub PomykałabyJakubDecember 07, 2021

Automate image generation using Zapier. Create images using your templates, or take website screenshot with Zapier.

Read more
What is Image Generation?

What is Image Generation?

Jakub PomykałabyJakubNovember 29, 2021

Generate images using REST API, Zapier, Integromat, Google Sheets, and more!

Read more
What is Bannerly?

What is Bannerly?

Jakub PomykałabyJakubNovember 29, 2021

Learn more about Bannerly, its features and how you can scale your designs with external tools like Zapier and Integromat.

Read more
How to Boost Your Social Media Engagement with Images

How to Boost Your Social Media Engagement with Images

Julia ReznerbyJuliaNovember 27, 2021

Ready to step up your social media game? Learn how images can affect your results!

Read more

Design. Automate. Scale.

Free plan • No credit card required • Get started in minutes