UrlPreviewParser 1.0.3

dotnet add package UrlPreviewParser --version 1.0.3
                    
NuGet\Install-Package UrlPreviewParser -Version 1.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="UrlPreviewParser" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="UrlPreviewParser" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="UrlPreviewParser" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add UrlPreviewParser --version 1.0.3
                    
#r "nuget: UrlPreviewParser, 1.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package UrlPreviewParser@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=UrlPreviewParser&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=UrlPreviewParser&version=1.0.3
                    
Install as a Cake Tool

UrlPreviewParser

NuGet License: MIT

A .NET library for extracting link preview metadata (OpenGraph, Twitter Card, oEmbed) from URLs.

Installation

.NET CLI

dotnet add package UrlPreviewParser

Package Manager

Install-Package UrlPreviewParser

PackageReference

<PackageReference Include="UrlPreviewParser" Version="1.0.2" />

Quick Start

using UrlPreviewParser;

using var client = new UrlPreviewClient();
var result = await client.GetPreviewAsync("https://example.com");

// OpenGraph
Console.WriteLine(result.OpenGraph.Title);
Console.WriteLine(result.OpenGraph.Description);
Console.WriteLine(result.OpenGraph.Image);

// Twitter Card
Console.WriteLine(result.TwitterCard.Title);
Console.WriteLine(result.TwitterCard.Image);

// Basic page title
Console.WriteLine(result.Tags.Title);

Accessing the Data

OpenGraph (result.OpenGraph)

OpenGraphData extends Dictionary<string, string>. Any og:* property is accessible by key (e.g., result.OpenGraph["og:title"]). Convenience properties cover the most common fields:

Property Key
Title og:title
Description og:description
Image og:image
Url og:url
Type og:type
SiteName og:site_name

Twitter Card (result.TwitterCard)

TwitterCardData extends Dictionary<string, string>. Any twitter:* property is accessible by key (e.g., result.TwitterCard["twitter:label1"]). Convenience properties:

Property Key Notes
Card twitter:card e.g. summary, summary_large_image
Title twitter:title
Description twitter:description
Image twitter:image Falls back to twitter:image:src
Url twitter:url
Site twitter:site @username of the website
Creator twitter:creator @username of the content creator

oEmbed (result.Oembed)

Discovered oEmbed endpoint URLs and the raw response body:

Property Type Description
Json string? URL of the JSON oEmbed endpoint
Xml string? URL of the XML oEmbed endpoint
Formats List<string> Discovered format names (e.g. "json", "xml")
Body string? Raw response body from the oEmbed endpoint
Error string? Error message if the endpoint fetch failed

Tags (result.Tags)

Property Type Description
Title string? Content of the HTML <title> element
Images List<string> Image URLs found on the page

Raw head elements (result.Head)

result.Head is a List<Dictionary<string, string?>> containing the raw attributes of every child element of <head>. Useful when you need access to tags not covered by the typed properties.

Using Your Own HttpClient

When using dependency injection, pass your HttpClient directly. The caller is responsible for its lifetime; UrlPreviewClient will not dispose it.

// ASP.NET Core — register via IHttpClientFactory
builder.Services.AddHttpClient<MyService>();

// Then inject and use
public class MyService(IHttpClientFactory factory)
{
    public async Task<UrlPreviewResult> GetPreviewAsync(string url, CancellationToken ct)
    {
        var httpClient = factory.CreateClient();
        using var client = new UrlPreviewClient(httpClient);
        return await client.GetPreviewAsync(url, ct);
    }
}

Offline Parsing

ParseAsync parses metadata from an HTML string without making any HTTP requests. The oEmbed endpoint is discovered but not fetched.

using var client = new UrlPreviewClient();
var result = await client.ParseAsync("https://example.com", htmlString);

License

MIT — see LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3 79 5/11/2026
1.0.2 84 5/9/2026
1.0.1 106 4/16/2026
1.0.0 92 4/16/2026