ParkSquare.RealTimeTrains 3.0.17

C# National Rail Realtime Train Departures, Arrivals & Live Running Information

Background

C# library for retrieving real time train information from Network Rail, National Rail other data sources via the Realtime Trains API. It also provides accurate data regarding timetables, services, bus replacements and platform information.

Getting Started

The source data feed is free for personal, academic and educational use. To connect to the Realtime Trains API you will need access credentials, which can be obtained by going to the Realtime Trains Developer portal. These credentials are in the form of a username and password, which this library will automatically add to your calls.

The main class you will need is RealTimeTrainsClient. To create one of these, you will need to pass in an HttpClient and an implementation of IClientConfig. It's up to you how you implement IClientConfig, for example you may bind it to entries in your appsettings.config or to secrets in an Azure Key Vault. Here is a simple example with hardcoded values:

public class ClientConfig : IClientConfig
{
    public string BaseUrl => "https://api.rtt.io/api/v1/";

    public string Username => "rttapi_yourusername";

    public string Password => "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
}

The recommended way to instantiate your RealTimeTrainsClient is to use Dependency Injection. Read about HttpClient dependency injection with .Net Core and then come back. Here is an example of how to register the required dependencies in your project:

services.AddSingleton<IRealTimeTrainsClient, RealTimeTrainsClient>();
services.AddSingleton<IClientConfig, ClientConfig>();
services.AddHttpClient();

You can now access the RealTimeTrainsClient by simply adding an IRealTimeTrainsClient to the constructor of the class where you want to use it.

This allows you to search for arrivals, departures, or get detailed information on a specific service. There are several overloaded methods that allow your search to be more, or less, precise. Here is an example that retrieves current departures from London Kings Cross, and then lists the realtime station data for the last service it finds.

public class RealTimeTrainsDemo
{
    private readonly IRealTimeTrainsClient _client;

    public RealTimeTrainsDemo(IRealTimeTrainsClient client)
    {
        _client = client;
    }

    public async Task RunAsync()
    {
        var services = await _client.GetDeparturesAsync("KGX");

        Console.WriteLine("Services departing from London King's Cross:");

        foreach (var service in services.Services)
        {
            var origin = service.LocationDetail.Origin.First();
            var destination = service.LocationDetail.Destination.Last();

            Console.WriteLine($"\t{service.RunningIdentity}\t{service.ServiceUid}\t" +
            $"{origin.PublicTime} {origin.Description} --> " +
            $"{destination.PublicTime} {destination.Description} " +
            $"({service.LocationDetail.Description})");
        }

        var lastService = services.Services.Last();

        var now = DateTime.Now;
        var serviceDetail = await _client.GetServiceAsync(lastService.ServiceUid, new DateFilter(now.Year, now.Month, now.Day));

        foreach (var callingPoint in serviceDetail.Locations)
        {
            Console.WriteLine($"\t\t\tRealtime Data: ARR {callingPoint.RealtimeArrival} DEP {callingPoint.RealtimeDeparture} AT {callingPoint.Description} PLATFORM {callingPoint.Platform}");
        }
    }
}

All methods on the RealTimeTrainsClient object have equivalent non-async methods for backward compatibility.

For more information, see the Realtime Trains Location Listing documentation.

Note that 'Service Unique IDs' are only unique for a particular day, so you must also pass in the date you're interested in to this call. For more information, see the Realtime Trains Service Information documentation.

Example Usage

A live demo of this library can be found at thetrain.rocks.