Getting Started

Installation & Setup

Add the UaDetector package (from NuGet) to the project.

$ dotnet add package UaDetector

To use UaDetector, register it in Program.cs with the AddUaDetector() method. To use a sub-parser, register it using its dedicated method: AddOsParser(), AddBrowserParser(), AddClientParser(), or AddBotParser(). All sub-parsers, except AddBotParser(), can be configured via UaDetectorOptions using the Options pattern as shown below.

using UaDetector;

builder.Services.AddUaDetector();

Configuration Options

Option	Type	Default	Description
VersionTruncation	enum	Minor	Controls how version numbers are shortened (e.g., None, Major, Minor, Patch, Build).
DisableBotDetection	bool	false	Disables bot detection entirely, skipping bot-related checks and parsing.

Quick Start

Each parser provides two TryParse() methods: one that accepts only the user agent string and another that accepts both the user agent string and a collection of HTTP headers. For more accurate detection, it is recommended to provide the HTTP headers.

Tip

Avoid directly instantiating parsers. The first call to TryParse() causes a noticeable delay due to regular expression compilation. Register services with dependency injection to prevent this runtime cost.

Basic Usage

[ApiController]
public class UaDetectorController : ControllerBase
{
    private readonly IUaDetector _uaDetector;

    public UaDetectorController(IUaDetector uaDetector)
    {
        _uaDetector = uaDetector;
    }

    [HttpGet]
    [Route("ua-detector")]
    public IActionResult GetUserAgentInfo()
    {
        var userAgent = Request.Headers.UserAgent.ToString();
        var headers = Request.Headers.ToDictionary(
            h => h.Key,
            h => h.Value.ToArray().FirstOrDefault()
        );

        if (_uaDetector.TryParse(userAgent, headers, out var result))
        {
            return Ok(result);
        }

        return BadRequest("Unrecognized user agent");
    }
}

Bot Detection

The BotParser class provides an additional IsBot() method to determine whether a user agent string represents a bot.

using UaDetector.Parsers;

var botParser = new BotParser();
const string userAgent = "Mozilla/5.0 (compatible; Discordbot/2.0; +https://discordapp.com)";

if (botParser.IsBot(userAgent))
{
    Console.WriteLine("Bot detected");
}
else
{
    Console.WriteLine("No bot detected");
}

Example Output

Input:

Mozilla/5.0 (Linux; Android 14; SAMSUNG SM-S926B) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/23.0 Chrome/115.0.0.0 Mobile Safari/537.36

Output:

{
  "os": {
    "name": "Android",
    "code": 2,
    "version": "14",
    "cpuArchitecture": null,
    "family": "Android"
  },
  "browser": {
    "name": "Samsung Browser",
    "code": 513,
    "version": "23.0",
    "family": "Chrome",
    "engine": {
      "name": "Blink",
      "version": "115.0"
    }
  },
  "client": null,
  "device": {
    "type": 2,
    "model": "Galaxy S24+",
    "brand": {
      "name": "Samsung",
      "code": 1497
    }
  },
  "bot": null
}

Registry Access

Static registry classes offer bidirectional lookups for converting between enum codes and their corresponding string names. The BrowserRegistry, OsRegistry, and BrandRegistry classes provide type-safe access to predefined values.

// Look up a browser name by its code
if (BrowserRegistry.TryGetBrowserName(BrowserCode.Safari, out var browserName))
{
    Console.WriteLine($"Browser Name: {browserName}");
}
else
{
    Console.WriteLine("Browser name not found");
}

// Look up a browser code by its name
if (BrowserRegistry.TryGetBrowserCode("Safari", out var browserCode))
{
    Console.WriteLine($"Browser Code: {browserCode}");
}
else
{
    Console.WriteLine("Browser code not found");
}