Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paripsky/og-scrapi
A Deno API that retrieves meta tags from any URL
https://github.com/paripsky/og-scrapi
api deno metatags
Last synced: 3 days ago
JSON representation
A Deno API that retrieves meta tags from any URL
- Host: GitHub
- URL: https://github.com/paripsky/og-scrapi
- Owner: paripsky
- License: mit
- Created: 2023-06-11T17:36:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-30T21:46:36.000Z (6 months ago)
- Last Synced: 2024-11-09T16:17:56.311Z (about 2 months ago)
- Topics: api, deno, metatags
- Language: TypeScript
- Homepage: https://og-scrapi.deno.dev/
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OG Scrapi
OG Scrapi is a Deno API that retrieves Open Graph (OG) meta tags and other
metadata from a given URL, providing a convenient way to access and utilize
website metadata.
## Getting Started
### Prerequisites
- [Deno](https://deno.land/) - A secure runtime for JavaScript and TypeScript.
### Installation
1. Clone the repository:
```sh
git clone https://github.com/paripsky/og-scrapi.git
cd og-scrapi
```
2. Run the Deno server:
```sh
deno run --allow-net --allow-read main.ts
```
## Usage
### Endpoints
- `GET /`: Welcome message.
- `GET /api/meta?url=`: Get Open Graph (OG) meta tags and other metadata
from the specified URL.
#### Example
Request:
```
GET /api/meta?url=https://example.com
```
Response:
```json
{
"og:title": "Example",
"og:description": "An example website",
"og:image": "https://example.com/image.png",
"title": "Welcome to Example"
// ...other metadata
}
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
for details.
## Acknowledgements
- [Deno](https://deno.land/)
- [deno_dom](https://deno.land/x/deno_dom)
## Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.