Browshot API
Take screenshots of any website in real time
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Take screenshots of any website in real time
Endpoints 17
Account
- GETGet information about your account
/account/info?details=1Get information about your account.
Batch
- POSTRequests thousands of screenshtos at once
/batch/ceate?hosting=s3&hosting_height=1&hosting_width=1&hosting_scale=1&hosting_bucket=string&hosting_file=string&hosting_headers=stringGet hundreds or thousands of screenshots from a text file. You can use this API call or the dashboard. Unlike the other API calls, you must issue a POST… - GETGet the batch status
/batch/info?id=0Get the status of a batch requested through the API or through the dashboard.
Browser
- GETGet information about a browser
/browser/info?id=0Get information about a browser. - GETGet all browsers
/browser/listGet all browsers.
Instance
- GETGet information about an instance
/instance/info?id=0Get information about an instance. - GETGet all instances
/instance/listGet all instances.
Screenshot
- GETRequest a screenshot
/screenshot/create?url=string&instance_id=0&size=screen&cache=86400&delay=5&flash_delay=10&screen_width=1024&screen_height=768&priority=1&referer=string&post_data=string&cookie=string&script=string&details=2&html=0&max_wait=0&headers=string&shots=1&shot_interval=5&hosting=s3&hosting_height=1&hosting_width=1&hosting_scale=1&hosting_bucket=string&hosting_file=string&hosting_headers=stringScreenshots requests to private and shared instances require a positive balance. *IMPORTANT*: Remember that you can only do 100 free screenshots per month. To… - GETDelete screenshot data
/screenshot/delete?id=0&data=imageYou can delete details of your screenshots to remove any confidential information. - GETHost thumbnails on your own S3 account or on Browshot.
/screenshot/host?id=0&hosting=s3&width=1&height=1&scale=1&bucket=string&file=string&headers=stringYou can host screenshots and thumbnails on your own S3 account or on Browshot. - GETGet the HTML code
/screenshot/html?id=0Retrieve the HTML code of the rendered page. This API call should be used when html=1 was specified in the screenshot request. - GETQuery screenshot status
/screenshot/info?id=0&details=2Once a screenshot has been requested, its status must be checked until it is either "error" or "finished". - GETGet information about screenshots
/screenshot/list?limit=100&status=errorGet information about the last 100 screenshots requested. - GETRequest multiple screenshots
/screenshot/multiple?url=string&instance_id=0&size=screen&cache=86400&delay=5&flash_delay=10&screen_width=1024&screen_height=768&priority=1&referer=string&post_data=string&cookie=string&script=string&details=2&html=0&max_wait=0&headers=string&hosting=s3&hosting_height=1&hosting_width=1&hosting_scale=1&hosting_bucket=string&hosting_file=string&hosting_headers=stringRequest multiple screenshots in one API call. The API call accepts all the parameters supported by screenshot/create. You can specify up to 10 URLs and 10… - GETSearch for screenshots
/screenshot/search?url=string&limit=50&status=errorSearch for screenshots of a specific URL. - GETShare a screenshot
/screenshot/share?id=0¬e=stringYou can make your screenshots public, add notes, and share it with your friends and colleagues. Only screenshots which are successfully completed can be… - GETRetrieve a thumbnail image
/screenshot/thumbnail?id=0&width=1&height=1&scale=1&zoom=100&ratio=fit&left=0&right=0&top=0&bottom=0&format=png&shot=1&quality=100Unlike the other API calls, this API sends back the thumbnail as a PNG file, not JSON. The HTTP response code indicates whether the screenshot was successful…
API details
- Base URL
https://api.browshot.com/api/v1- Authentication
- An API key in the key query parameter
- Operations
- 17 operations on 17 pathsGET 16POST 1
- Main resources
- Screenshot 10Batch 2Browser 2Instance 2Account 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.17.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Browshot API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Browshot API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get information about your account” (GET /account/info?details=1), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Browshot API?
Take screenshots of any website in real time It is listed under Developer tools and has 17 endpoints.
Who publishes the Browshot API?
It is listed from Browshot's public API description (an OpenAPI document), not published by Browshot on Swastik Codes. Anyone who controls browshot.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Browshot API?
Requests go to https://api.browshot.com/api/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Browshot API?
With an API key in the key query parameter.
How many endpoints does the Browshot API have?
17 operations on 17 paths (16 GET, 1 POST). The largest groups are Screenshot, Batch, Browser, Instance.
Is forking the Browshot API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.