Skip to content

Repository files navigation

jURAclient

CIQuality Gate StatusJavadocsMaven Central VersionLicense

Java client for URA based public transport APIs.

This client allows to simply connect any Java application to the public transport API to implement a monitor for the local bus station or any other custom queries. API versions 1.x and 2.x are supported.

Supported versions

Version 3.x requires Java 17 or later and depends on Jackson 3.

Version 2.x requires Java 11 or later. It also contains some new features and allows configuration using a dedicated configuration object.

Version 1.x requires Java 8 or later. This version is no longer supported and will not receive any future updates.

Usage Examples

Initialization

// Instantiate the client.UraClientura = newUraClient("https://ura.example.com");
// Initialize the API with non-standard endpoints.UraClientura = newUraClient("https://ura.example.com", "interfaces/ura/instant_V2", "interfaces/ura/stream_V2");
// Initialization with configuration builder (Client v2.x)UraClientura = newUraClient(
UraClientConfiguration.forBaseURL("https://ura.example.com")
.withInstantPath("interfaces/ura/instant_V2")
.withStreamPath("interfaces/ura/stream_V2")
.withConnectTimeout(Duration.ofSeconds(2))
.withTimeout(Duration.ofSeconds(10))
.build()
);

List Stops

// List ALL available stopsList<Stop> stops = ura.getStops();
// List available stops in a 200m radius around given coordinatesList<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
.getStops();

Get Trips

// Get next 10 trips for given stops and lines in a single direction (all filters optional)List<Trip> trips = ura.forStops("100000")
.forLines("25", "35")
.forDirection(1)
.getTrips(10);
// Get trips from given stop towards your destinationList<Trip> trips = ura.forStopsByName("Piccadilly Circus")
.towards("Marble Arch")
.getTrips();

Get Messages

// Get next 10 trips for given stops and lines in a single direction (all filters optional)List<Message> msgs = ura.forStops("100000")
.getMessages();

Maven Artifact

<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.11</version>
</dependency>

License

The project is licensed under Apache License 2.0.

About

Java client for URA based public transport APIs

Topics

Resources

Contributing

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages