Unfurl.Net 1.1.0

Unfurl.Net

A .net metadata scraper that supports X (nee Twitter) Cards, Open Graph, and oEmbed.

Installation

Unfurl.Net is published as a NuGet package. Download from your favorite nuget package manager.

--or--

Install from the command line with:

dotnet add package Unfurl.Net

Overview

Unfurl.Net is inspired by the unfurl.js nodejs project which parses meta data from HTML content and turns it into a convenient object model for displaying URL previews and cards similar to how Facebook, Slack, Discord, or Twitter do.

This library just parses the Html for OpenGraph and Twitter Card <meta /> tags and turns it into an easy to use object. It does not actually build a visual representation of the Url.

Unfurl.Net is a simple library that depends on the venerable HtmlAgilityPack for its parsing.

Usage

Basic usage that loads open graph and X/Twitter cards:

var unfurler = new Unfurler();
var url = "https://developer.x.com/en/docs/x-for-websites/cards/overview/markup";
var results = await unfurler.Unfurl(url);

Include oEmbed data:

var httpClient = new HttpClient(); // <-- don't do this in production!
var unfurler = new Unfurler();
var url = "https://www.youtube.com/watch?v=5EI0OP7o8cM";
var results = await unfurler.Unfurl(url, new UnfurlOptions()
{
    LoadOEmbed = true,
    OEmbedHttpClient = httpClient,
});

Handle redirects and shortened links:

var unfurler = new Unfurler();
var url = "https://www.youtube.com/watch?v=5EI0OP7o8cM";
var results = await unfurler.Unfurl(url, new UnfurlOptions()
{
    MaximumRedirects = 2,
});

All Options:

Roadmap

The current features are sufficient for my needs. But if there are any additional features you would like to see, please add an issue (or even submit a PR if you want) and I will work on adding them.

Here are some features that could be added:

• Accept Html as a string or stream for parsing, and not just a Url that has to be downloaded. This will allow alternate methods of downloading Urls and Unfurl.Net can be used simply as the parser, not also as the Html downloader.