curl - Linux, Mac OS X, BSD

Use of the API requires authentication with your API key. Your key is displayed in the right column in your dashboard. If you do not yet have an account, please register for a free account.

The simple API makes it easy to request and retrieve screenshots with curl.

Browshot will send 302 redirections, so you need to use the -L option to follow them. To request a screenshot of http://mobilito.net/ and save to /tmp/mobilito.png:

$ curl -L "https://api.browshot.com/api/v1/simple?url=http://mobilito.net/&key=my_api_key" -o /tmp/mobilito.png
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  188k  100  188k    0     0   5692      0  0:00:33  0:00:33 --:--:--  118k

$ file /tmp/mobilito.png
/tmp/mobilito.png: PNG image data, 1024 x 768, 8-bit/color RGB, non-interlaced

You can use any of the options listed on the API page. Here are some common use cases:

Full page

$ curl -L "https://api.browshot.com/api/v1/simple?url=http://mobilito.net/&key=my_api_key&width=640&size=page" -o /tmp/mobilito.png

Thumbnail

$ curl -L "https://api.browshot.com/api/v1/simple?url=http://mobilito.net/&key=my_api_key&width=640" -o /tmp/mobilito.png

$ curl -L "https://api.browshot.com/api/v1/simple?url=http://mobilito.net/&key=my_api_key&width=640&height=480" -o /tmp/mobilito.png

Choose a virtual browser

$ curl -L "https://api.browshot.com/api/v1/simple?url=http://mobilito.net/&key=my_api_key&instance_id=22" -o /tmp/mobilito.png

All options can be combined. See the API page for the full list.