Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ari-party/flash
⚡ An open source screenshot API built with Puppeteer and Express 📸
https://github.com/ari-party/flash
api express puppeteer puppeteer-screenshot screenshot screenshot-generator website-screenshot website-screenshot-capturer
Last synced: 4 days ago
JSON representation
⚡ An open source screenshot API built with Puppeteer and Express 📸
- Host: GitHub
- URL: https://github.com/ari-party/flash
- Owner: ari-party
- License: mit
- Created: 2023-08-16T14:03:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-27T01:01:00.000Z (12 months ago)
- Last Synced: 2024-01-13T01:24:04.399Z (10 months ago)
- Topics: api, express, puppeteer, puppeteer-screenshot, screenshot, screenshot-generator, website-screenshot, website-screenshot-capturer
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Flash
An open source screenshot API built with Puppeteer and Express
## Configuration
Flash uses [dotenv](https://www.npmjs.com/package/dotenv) for configuration, which exists out of 2 options:
- `AUTH` — The value of the `authorization` header in requests
- `PORT` — The port the Express server will be listening on
## Using Flash
`POST /`
```json
{
"url": "https://google.com", // The url of the website to screenshot
"screenWidth": 1920, // The width of the Puppeteer page
"screenHeight": 1080, // The height
// The parameters above are required
"clip": {
"x": 0, // Clip zone horizontal offset
"y": 0, // Clip zone vertical offset
"width": 1920, // The width of the clip zone (screenshot)
"height": 1080 // The height
},
"enableJavaScript": true, // Enable JavaScript on the page
"wait": 0, // Bare time to wait on the page, in ms
"waitForNetworkIdle": true, // If Puppeteer should wait until the page is network idling
// (https://pptr.dev/api/puppeteer.page.waitfornetworkidle)
"waitForSelector": false, // If Puppeteer should wait until the selector (CSS selector, string) is available on page
"wait": 1000, // The time Puppeteer will wait before returning nothing as response, in ms
"scale": 1, // Like deviceScaleFactor
// (https://pptr.dev/api/puppeteer.screenshotclip/#properties > scale)
"full": false, // Take a screenshot of the entire page, not just the viewport
// (https://pptr.dev/api/puppeteer.page.screenshot#remarks > fullPage)
"type": "png", // png (default) / jpeg / webp
"quality": 0 // Quality of image, 0 - 100, not applicable on png
}
```
## Examples
`POST /`
```json
{
"url": "https://www.google.com/?hl=en",
"screenWidth": 1920,
"screenHeight": 1080,
"enableJavaScript": true
}
```
Response returned in 383ms
---
`POST /`
```json
{
"url": "https://www.youtube.com/?hl=en",
"screenWidth": 1920,
"screenHeight": 1080,
"enableJavaScript": true,
"wait": 1000
}
```
Response returned in 2.78s
