https://github.com/toddbirchard/linkbox-api

:link: :package: A single endpoint which generates metadata previews of any given URL.
https://github.com/toddbirchard/linkbox-api

beautifulsoup4 flask gcloud google-cloud-platform python3

Last synced: 2 months ago
JSON representation

:link: :package: A single endpoint which generates metadata previews of any given URL.

• Host: GitHub
• URL: https://github.com/toddbirchard/linkbox-api
• Owner: toddbirchard
• Created: 2018-11-11T08:49:21.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-16T06:25:34.000Z (over 5 years ago)
• Last Synced: 2025-04-14T09:58:14.415Z (6 months ago)
• Topics: beautifulsoup4, flask, gcloud, google-cloud-platform, python3
• Language: Python
• Homepage: https://linkboxapi.com
• Size: 6.31 MB
• Stars: 15
• Watchers: 0
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Linkbox API

![Python](https://img.shields.io/badge/Python-v3.7-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)

![Flask](https://img.shields.io/badge/Flask-v1.0.2-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)

![BeautifulSoup](https://img.shields.io/badge/BeautifulSoup4-v4.6.3-blue.svg?longCache=true&logo=python&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)

![Google Cloud Functions](https://img.shields.io/badge/Google--Cloud--Functions-v93-blue.svg?longCache=true&logo=google&longCache=true&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)

![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c)

[![GitHub Issues](https://img.shields.io/github/issues/toddbirchard/linkbox-api.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b&logo=Github)](https://github.com/toddbirchard/linkbox-api/issues)

[![GitHub Stars](https://img.shields.io/github/stars/toddbirchard/linkbox-api.svg?style=flat-square&colorB=ebcb8b&colorA=4c566a&logo=Github)](https://github.com/toddbirchard/linkbox-api/stargazers)

[![GitHub Forks](https://img.shields.io/github/forks/toddbirchard/linkbox-api.svg?style=flat-square&colorA=4c566a&colorB=ebcb8b&logo=Github)](https://github.com/toddbirchard/linkbox-api/network)

![Link Preview](https://raw.githubusercontent.com/toddbirchard/linkbox-api/master/img/linkboxdemo.gif)

**Linkbox** is an API which generates beautiful embedded link previews for any given URL.

## Usage

Linkbox is a single GET endpoint which accepts a `?url=` parameter and returns best-guess metadata for the target site. A preview can be found on the Linkbox API website.

## Features in Development

There are several major features which remain in development:

* **AI-Generated Summaries**: Get the best synopsis of an article or webpage possible by letting robots write them for you.

* **Returning Embed HTML**: Instead of simply returning JSON containing metadata per request, users will be able to opt in to instead receiving a text response of HTML for an embedded widget.

* **Customized Responses**: Some content providers (such as Medium) are intentionally resistant to scrapers. Exceptions for such sources will be handled on a case-by-case basis to ensure meaningful data is returned.

* **Content Awareness**: Depending on the content of the link, a different embed will be returned to best display said content.

* **Direct Database Writes**: Integration with a site's content database to ensure HTML is hard-embedded to the page as opposed to a client-side script.

-----

This project and all publically-visible repositories are free of charge. If you've found this project to be helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards improving these projects.