https://github.com/darkterminal/rest-screenshoot

REST Screenshoot is a free tool for capturing screenshots of webpages via a REST API. Free an always!
https://github.com/darkterminal/rest-screenshoot

open-source puppeteer rest-api screenshoot

Last synced: 3 days ago
JSON representation

REST Screenshoot is a free tool for capturing screenshots of webpages via a REST API. Free an always!

• Host: GitHub
• URL: https://github.com/darkterminal/rest-screenshoot
• Owner: darkterminal
• License: other
• Created: 2023-03-26T22:52:48.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-27T09:04:36.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T06:48:08.895Z (about 2 months ago)
• Topics: open-source, puppeteer, rest-api, screenshoot
• Language: JavaScript
• Homepage: https://rest-screenshoot.fly.dev/screenshot?url=https://metaphore.vercel.app/stories/javascript/react-table-sever-side-pagination-search-sortorder
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# REST Screenshoot 📸

REST Screenshoot is a free tool for capturing screenshots of webpages via a REST API. It provides a simple, easy-to-use endpoint URL for generating screenshots.

## Endpoint URL

To generate a screenshot, make a GET request to the following endpoint URL, replacing `{url}` with the URL of the webpage you want to capture:

`https://rest-screenshoot.fly.dev/screenshot?url={url}`

## Example

To capture a screenshot of the React Table server-side pagination, search, and sort order story on Metaphore, use this URL:

`https://rest-screenshoot.fly.dev/screenshot?url=https://metaphore.vercel.app/stories/javascript/react-table-sever-side-pagination-search-sortorder`

The resulting screenshot will be returned as a PNG image.

## Options

| Query    | Type     | Description                           | Required |

| :------- | :------- | :------------------------------------ | :------- |

| `url`    | `string` | Valid url for target website          | Yes      |

| `width`  | `number` | Valid Number (pixel) default is `850` | No       |

| `height` | `number` | Valid Number (pixel) default is `400` | No       |

| `pick`   | `string` | Valid CSS Selector for element        | No       |

Note: This project idea is an extension for [Metaphor Website](https://metaphore.vercel.app)

## Donation / Support

If you find REST Screenshoot to be a helpful tool for your website or application, please consider supporting the project. Your donation or sponsorship can help ensure that the project continues to thrive and improve over time. You can sponsor the project directly through Github Sponsor or donate through Paypal. Your support is greatly appreciated and will help to ensure that this powerful tool remains available for free to users all over the world. Thank you for your generosity and support!