Skip to content

README.markdown

Latest commit

 

History

History
53 lines (26 loc) · 2.28 KB

README.markdown

File metadata and controls

53 lines (26 loc) · 2.28 KB

Galway Bus RTPI API

The rtpi.ie website has access to real-time data for the Galway Bus Éireann transit system. Unfortunately, this data is not officially accessible to developers, and is in a weird, proprietary, JSON-ish format. The aim of this project is to provide a simple API to access this data, returning it in a valid JSON format. It was also a good excuse to finally learn how to use node.js :)

Live demo available at http://galwaybus.herokuapp.com

For more info, visit http://www.vinnycoyne.com

Usage

Routes

  • GET /routes.json

Lists all the available bus routes in the Galway transit system. This list is hard-coded and would need to be updated manually, should the routes ever change.

  • GET /routes/<timetable_id>.json

Returns a list of stops on a given route. Use the timetable_id retrieved from the routes.json API. In the reponse, the stops key will contain all stops, separated into two arrays — the separate arrays represent the opposite directions taken by the bus on the route.

Stops

  • GET /stops.json

Lists all the available bus stops in the Galway transit system.

  • GET /stops/<stop_ref>.json

Returns a list of departure times for a given bus stop. Use the stop_ref retrieved from the stops.json API.

  • GET /stops/nearby.json?latitude=<latitude>&longitude=<longitude>&route=<timetable_id>

    Lists ten nearest stops to the coordinates provided in the latitude and longitude URL parameters. Includes departure times.

    Optionally, use the timetable_id retrieved from the routes.json API to only return stops which service the provided route.

Schedules

  • GET /schedules.json

Lists all the available bus routes in the Galway transit system, including links to their PDF timetables on the Bus Éireann website. This list is hard-coded and would need to be updated manually, should the routes ever change.

Buses

  • GET /bus.json

Lists all buses currently assigned to a Galway transit route.

  • GET /bus/<timetable_id>.json

Returns a subset of buses that are assigned to a specific route. Use the timetable_id retrieved from the routes.json API. In the reponse, the bus key will contain an array of assigned bus objects.