Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dishwasher-detergent/screenshot
Take photos, videos, and get metadata about any site with ease!
https://github.com/dishwasher-detergent/screenshot
appwrite appwrite-function
Last synced: 2 months ago
JSON representation
Take photos, videos, and get metadata about any site with ease!
- Host: GitHub
- URL: https://github.com/dishwasher-detergent/screenshot
- Owner: dishwasher-detergent
- License: mit
- Created: 2023-09-21T21:48:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-28T16:18:48.000Z (10 months ago)
- Last Synced: 2024-02-28T17:36:30.214Z (10 months ago)
- Topics: appwrite, appwrite-function
- Language: TypeScript
- Homepage: https://api.jibby.space/
- Size: 140 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 🧰 Usage
### GET /
Returns HTML website with documentation for API.
**Response**
### GET /screenshot/:url
Returns an webp/png/jpeg image of the specified URL;
**Options**
| Query Param | Type | Default Value |
|----------------|---------------------|---------------|
| width | number | 1280 |
| height | number | 720 |
| scale | number | 1 |
| clipX | number | |
| clipY | number | |
| quality | number | 80 |
| format | jpeg \| webp \| png | webp |
| fullPage | boolean | false |
| omitBackground | boolean | false |
| darkMode | boolean | false |
**Response**
Sample `200` Response:
```
(image buffer)
```
### GET /video/:url
Returns an mp4 video of the specified URL;
**Options**
| Query Param | Type | Default Value |
|----------------|---------------------|-------------------|
| width | number | 1280 |
| height | number | 720 |
| scale | number | 1 |
| darkMode | boolean | false |
| animation | string | 1000,500,0,smooth |
Animation values are created in the format: wait (the duration it stays after an animation has played), top (how many pixels to go from the top), left (how many pixles to go from the left), behavior (smooth, instant, auto)
Animations can be chained together using a colon. Example 1000,100,0,smooth:1000,300,0,smooth
**Response**
Sample `200` Response:
```
(video buffer)
```
### GET /metadata/:url
Returns a json representation of the meta tags for the specified URL;
**Response**
Sample `200` Response:
```json
[
{
"charset": "utf-8"
},
{
"name": "description",
"content": "Kenneth Bass' Portfolio of Projects!"
},
{
"name": "viewport",
"content": "width=device-width, initial-scale=1"
}
]
```
## ⚙️ Configuration
| Setting | Value |
| ----------------- | ------------- |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install` |
| Permissions | `any` |
| Timeout (Seconds) | 30 |