linkpreview

Get link preview in python

Gathering data from:

OpenGraph meta tags
TwitterCard meta tags
Microdata meta tags
JSON-LD meta tags
HTML Generic tags (h1, p, img)
URL readable parts

Install

pip install linkpreview

Usage

Basic

from linkpreview import link_preview

url = "http://localhost"
content = """
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width">
    <!-- ... --->
    <title>a title</title>
  </head>
  <body>
  <!-- ... --->
  </body>
</html>
"""
preview = link_preview(url, content)
print("title:", preview.title)
print("description:", preview.description)
print("image:", preview.image)
print("force_title:", preview.force_title)
print("absolute_image:", preview.absolute_image)
print("site_name:", preview.site_name)
print("favicon:", preview.favicon)
print("absolute_favicon:", preview.absolute_favicon)

Automatic fetch link content

from linkpreview import link_preview

preview = link_preview("http://github.com/")
print("title:", preview.title)
print("description:", preview.description)
print("image:", preview.image)
print("force_title:", preview.force_title)
print("absolute_image:", preview.absolute_image)
print("site_name:", preview.site_name)
print("favicon:", preview.favicon)
print("absolute_favicon:", preview.absolute_favicon)

`lxml` as XML parser

Very recommended for better performance.

Install the lxml and use it like this:

from linkpreview import link_preview

preview = link_preview("http://github.com/", parser="lxml")
print("title:", preview.title)
print("description:", preview.description)
print("image:", preview.image)
print("force_title:", preview.force_title)
print("absolute_image:", preview.absolute_image)
print("site_name:", preview.site_name)
print("favicon:", preview.favicon)
print("absolute_favicon:", preview.absolute_favicon)

Advanced

from linkpreview import Link, LinkPreview, LinkGrabber

url = "http://github.com"
grabber = LinkGrabber(
    initial_timeout=20,
    maxsize=1048576,
    receive_timeout=10,
    chunk_size=1024,
)
content, url = grabber.get_content(url)
link = Link(url, content)
preview = LinkPreview(link, parser="lxml")
print("title:", preview.title)
print("description:", preview.description)
print("image:", preview.image)
print("force_title:", preview.force_title)
print("absolute_image:", preview.absolute_image)
print("site_name:", preview.site_name)
print("favicon:", preview.favicon)
print("absolute_favicon:", preview.absolute_favicon)

Extend default headers:

content, url = grabber.get_content(url, headers={'user-agent': 'Twitterbot'})

Ignore default headers:

content, url = grabber.get_content(
  url,
  headers={'user-agent': 'Twitterbot', 'accept': '*/*'},
  replace_headers=True,
)

Use preset headers:

content, url = grabber.get_content( url, headers='googlebot')

Available presets: firefox, chrome, googlebot, twitterbot, telegrambot, imessagebot

If you already have parsed BeautifulSoup object:

from bs4 import BeautifulSoup
from linkpreview import Link, LinkPreview

url = "http://example.com"
content = "<h1>Hello</h1>"
soup = BeautifulSoup(content, "html.parser")
link = Link(url, content)
preview = LinkPreview(link, soup=soup)
print("title:", preview.title)

Release files for linkpreview 0.12.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for linkpreview 0.12.1
File	Size	Uploaded
linkpreview-0.12.1.tar.gz	15.4 kB	Aug 15, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for linkpreview 0.12.1
File	Interpreter	ABI	Platform	Reset
linkpreview-0.12.1-py3-none-any.whl 21.8 kB Aug 15, 2025	Python 3	none	any	Details

Total release size: 37.2 kB

Release files / linkpreview-0.12.1.tar.gz

Download URL	linkpreview-0.12.1.tar.gz
Size	15.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`4f3ec342a848d23dbe5c953daa574c4096a98167b4f8b41e57734a8e85b413e4`
BLAKE2b-256 checksum How to use checksums	`6654e538987c8ce1e8585a276ecf018ed8eb958eb17649e893d04bde235c7ccf`
Upload date	Aug 15, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Release files / linkpreview-0.12.1-py3-none-any.whl

Download URL	linkpreview-0.12.1-py3-none-any.whl
Size	21.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5343dc7475592fb7a6dd12ef13a8ea7cc4983641b43a465d3472695e6f3dd92e`
BLAKE2b-256 checksum How to use checksums	`fdbda973d4189aa3561a6abdd4e02971cd6a50b6ddb35eb3eec58f557535b1a6`
Upload date	Aug 15, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.9`