DotBahn.Common 2.1.0

<img src="docs/images/logo-256x256.png" width=128 alt="logo">

DotBahn - .NET Client for Deutsche Bahn APIs

DotBahn is a collection of unofficial .NET client packages for accessing Deutsche Bahn (DB) APIs. Query train schedules, station details, and facility status directly in your application. It also provides convenience features like timetable merging, fluent queries, and additional properties.

Table of Contents

• Install
• Usage
• Authorization
• Samples
• API Reference

Install

Install the packages you need from NuGet or GitHub Packages:

dotnet add package DotBahn.Timetables
dotnet add package DotBahn.Stations
dotnet add package DotBahn.Facilities

# Optional; see below for further details.
dotnet add package DotBahn.Telemetry

Usage

Dependency Injection (Recommended)

All packages integrate seamlessly with IServiceCollection. Each client comes with a default endpoint, override only for custom proxies:

// Register clients
services.AddDotBahnStations();
services.AddDotBahnTimetables();
services.AddDotBahnFacilities();

// Configure authorization (required for API access)
services.AddDotBahnAuthorization(opt => {
    opt.ClientId = clientId;
    opt.ApiKey = clientSecret;
});

...

// Optional: override default endpoints
services.AddDotBahnStations(opt => {
    opt.BaseEndpoint = new Uri("https://custom-proxy.example.com/stada");
});

Manual Initialization

Create client instances directly without dependency injection. Each client creates and owns its own HttpClient:

using var client = new StationClient(
    new ClientOptions {
        BaseEndpoint = new Uri("https://apis.deutschebahn.com/db-api-marketplace/apis/station-data/v2/")
    },
    new AuthorizationOptions {
        ClientId = clientId,
        ApiKey = clientSecret
    });

Telemetry

All clients emit OpenTelemetry-compatible traces and metrics using the built-in ActivitySource and Meter APIs. The client packages themselves have no OpenTelemetry dependency. Enable collection with the DotBahn.Telemetry package, which registers the source and meter with your OpenTelemetry providers:

// OpenTelemetry configuration
services.AddOpenTelemetry()
    .WithTracing(tracing => tracing.AddOtlpExporter())
    .WithMetrics(metrics => metrics.AddOtlpExporter());

// Add dotbahn specific activites
services.AddDotBahnTelemetry();

Authorization

A Deutsche Bahn API key is required. Register and obtain your credentials at the DB API Marketplace.

Samples

ICE Monitor

A terminal-based departure board for ICE trains at a given station. Displays train numbers, scheduled and actual departure times, platforms, destinations, and routes. Highlights delays and platform changes.

dotnet run --project samples/DotBahn.Samples.IceMonitor -- <EVA> <your-client-id> <your-client-secret>

<img src="https://i.imgur.com/Z3fKMo5.png" width=500>

Station Browser

An interactive terminal application for exploring DB station details. Search by name and navigate results with arrow keys. Shows station category, identifiers (EVA/RIL100), address, coordinates, regional area, available services, and real-time elevator/escalator status.

dotnet run --project samples/DotBahn.Samples.StationBrowser -- <SearchName> <your-client-id> <your-client-secret>

<img src="https://i.imgur.com/XWwBVr2.png" width=500>