Extruct.Net 0.18.0

Extruct.Net

A .NET port of the Python extruct library by Scrapinghub. Extracts embedded metadata from HTML documents across all major structured-data formats.

Supported formats

Library usage

using Extruct;

string html = File.ReadAllText("page.html");

ExtructResult result = Extractor.Extract(
    html,
    baseUrl: "https://example.com/page");

// Access a specific syntax
JsonArray jsonLd = result["json-ld"];
JsonArray microdata = result["microdata"];

// Serialize the full result
Console.WriteLine(result.ToJsonString());

Selecting syntaxes

ExtructResult result = Extractor.Extract(html,
    syntaxes: ["json-ld", "opengraph"]);

Uniform output

Normalizes supported formats (Microdata, Open Graph, Dublin Core, Microformats) to a JSON-LD-like shape with @type and @context:

ExtructResult result = Extractor.Extract(html,
    uniform: true,
    schemaContext: "http://schema.org");

Error handling

// Strict (default): throws on extractor failure
// Log: writes to Console.Error and continues
// Ignore: silently skips failed extractors

ExtructResult result = Extractor.Extract(html, errors: ErrorMode.Log);

// Override the log handler
Extractor.LogHandler = (message, ex) => logger.LogWarning(ex, message);

CLI

extruct [fetch|parse] <url-or-file> [options]

Fetch a URL

extruct fetch https://example.com/product

Parse a local file

extruct parse page.html
extruct parse page.html --base-url https://example.com/page

Options

Examples

# Extract only JSON-LD and Open Graph
extruct fetch https://example.com --syntaxes json-ld,opengraph

# Uniform output for structured data
extruct parse page.html --uniform --syntaxes microdata,json-ld

# Suppress extractor errors
extruct fetch https://example.com --errors ignore

Output format

The output mirrors the Python library exactly: a JSON object keyed by syntax name, each value an array of extracted items.

{
  "json-ld": [
    { "@context": "https://schema.org", "@type": "Product", "name": "..." }
  ],
  "opengraph": [
    {
      "namespace": { "og": "http://ogp.me/ns#" },
      "properties": [["og:title", "..."], ["og:image", "..."]]
    }
  ],
  "microdata": [],
  "rdfa": [],
  "microformat": [],
  "dublincore": []
}

Dependencies

• AngleSharp — HTML parsing
• dotNetRdf — RDFa parsing
• json-ld.net — JSON-LD processing
• Microformats — Microformats2 parsing
• CommandLineParser — CLI argument parsing

License

BSD 3-Clause