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)

Security

If URLs come from untrusted users, pass allow_private=False to avoid SSRF: only http/https URLs resolving to public addresses are fetched (re-checked on every redirect), otherwise BlockedAddressError is raised.

link_preview(url, allow_private=False)

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)

Metadata

Release files for linkpreview 0.13.2

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.13.2
File	Size	Uploaded
linkpreview-0.13.2.tar.gz	16.5 kB	Oct 14, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for linkpreview 0.13.2
File	Interpreter	ABI	Platform	Reset
linkpreview-0.13.2-py3-none-any.whl 22.8 kB Oct 14, 2026	Python 3	none	any	Details

Total release size: 39.3 kB

Release files / linkpreview-0.13.2.tar.gz

Download URL	linkpreview-0.13.2.tar.gz
Size	16.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`4a8ecce7142de2753a31a96b84048dcf4f5ea1f787ec2984101994ce3d916b0a`
BLAKE2b-256 checksum How to use checksums	`795fc845ee23c09a4d6d3d27a0193f0f47d20c73858bcaf55e0556195bd96bf0`
Upload date	Oct 14, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

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

Download URL	linkpreview-0.13.2-py3-none-any.whl
Size	22.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`aa30254ba30621f878fdb49f7151fc57ace125a1877b49f4317db1d4672ae011`
BLAKE2b-256 checksum How to use checksums	`87da4934194da81d15ad29a6b95e0272f283fe67eebeb06a6dafcfe17f1919b5`
Upload date	Oct 14, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`