Skip to content
Screenshot API

Screenshot API

A screenshot of any public page from one HTTP call. Monity’s own browser dismisses cookie and consent banners, loads lazy content and stitches the whole page into one image. 1 credit a screenshot, refunded when it fails.

Start free Read the docs
  • PNG, JPEG or WebP
  • Desktop or phone width
  • On every plan, the free one included

Monity’s browser

The page as a person sees it, from top to bottom.

Monity takes the screenshot with the browser its own checks use. It dismisses cookie and consent banners, blocks ads, scrolls so lazy images and content load, and stitches the whole page into one image.

  • The whole page, or only the first screen
  • Any viewport from 320 to 3,840 pixels wide, or a phone-sized one
  • Wait up to 10 seconds after the page loads, for pages that settle late
  • block_ads=false shows the page as a first visit does
Take your first screenshot
The Monity’s browser card in the app: cookie and consent banners dismissed, ads blocked, lazy images and content loaded, the whole page stitched into one image, a desktop or phone-sized viewport

Playground

Try every option before you write any code.

The Playground in the app has a field for every parameter, each labelled with its name in the API. Take a screenshot, look at it, then copy the same request as curl, JavaScript or Python.

  • The image with its size, file size, time and checks
  • The answer as the image or as JSON
  • Save as setup keeps the page and its options
Setups, Playground and Runs
The top of the Playground’s request form: the page, a setup to start from, the Whole page and Clear banners and ads switches, and Desktop or Phone, each labelled with its parameter

Setups

Save the pages you capture often, and call them by id.

A setup keeps a page and its options under a name. Send setup= with its id and the call takes the setup’s page and options; change the setup in the app and every call that uses it follows.

  • Any parameter you send overrides the setup’s
  • Take now from the app
  • Every screenshot listed in Runs, from the API or the app
Screenshot setups
The Setups tab: three setups with their name and id, the page, options such as Full page 1440 by 900 PNG, and Take now

API keys

The same API keys as the REST API.

Make a key in Integrations and switch on write access, because a screenshot spends a check. Send it in the Authorization header from your server, and every answer says what the request used and what is left.

  • X-Monity-Credits and X-Monity-Credits-Remaining on every answer
  • A failed capture is refunded; a screenshot reused from the cache is free
  • Paid from the workspace’s checks: the plan’s first, then bought ones
Parameters, answers and errors
The Developers section of Integrations with the REST API, Screenshot API and Webhook signing cards

FAQ

Questions about the Screenshot API

How much does a screenshot cost?
1 credit, from the workspace’s credits, the same ones its tasks use (1 credit = 1 check of a task). A page that cannot be captured is refunded, and a screenshot reused from the cache is free. The free plan’s 100 credits a month can pay for screenshots too. See pricing for the credits in each plan.
Which formats and sizes can I get?
PNG, JPEG or WebP, of the whole page or the first screen, at any viewport from 320 to 3,840 pixels wide, or a phone-sized one. The answer is the image itself, or JSON with the image’s address.
Does it remove cookie banners?
Yes, by default: cookie and consent banners are dismissed and ads blocked before the capture. Send block_ads=false to see the page as a first visit does.
Can it capture a page behind a login?
No. The Screenshot API takes public pages only, and refuses private and local addresses. To watch a page behind a sign-in, set up a monitor with a saved login instead.
Is a phone screenshot taken on a real phone?
No. device=mobile sets a phone-sized viewport, 390 by 844 pixels. The browser keeps its own identity, so a site that picks its phone pages by browser shows its desktop page at phone width.
How long are the images kept?
The image comes back in the answer, so you keep it. With output=json, its address works for 3 hours; the run stays in your list after that.
What if a site blocks automated browsers?
Some sites do not let any automated browser see their content. When a page cannot be captured, the answer says so and the check is refunded. Monity does not promise to get past every site’s bot protection.
Can I try it without writing code?
Yes. The Playground in the app (Developers › Screenshot API) has every option, and the free full-page screenshot tool takes one page without an account.

Related

Take your first screenshot in a minute.

Create a free account, make an API key with write access in Integrations, and send one request.

Start free Read the docs
  • Free plan: 100 credits a month
  • 1 credit a screenshot
  • Refunded when it fails
The Price card of the Screenshot API: 1 check a screenshot, paid from the workspace’s checks, refunded when the page cannot be captured, free when the cache answers
Kamil, Alex and Martyna Median reply under 6 hours

Have a question?

Pricing, security, or scoping - pick a route and you will land in a real person's inbox.

S Talk to sales Pricing and scoping H Get support Help with a monitor D Book a demo 30-minute walkthrough