Waratah Occupancy API

Sydney Trains has recently made estimated passenger load information for its fleet of Waratah trains available to the public.

Waratah trains have weight sensors installed on each carriage, which when coupled with the estimated weight of each passenger, can be used to provide an estimate of how busy the train is.

Some Transport for NSW endorsed apps have per-carriage level information provided through another data feed that is not public (yet). Sydney Trains and Transport for NSW plans to make per-carriage information available on Open Data through the existing GTFS-realtime data feeds. Whilst this work is being done, you can still access train-level passenger estimates by grabbing the information from the Trip Planner APIs.

This script will generate a JSON file occupancy.json with each Waratah train's trip ID and their corresponding occupancy status. The trip IDs should match the trip IDs found in the GTFS static and GTFS realtime feeds.

An example occupancy.json is provided in this repo.

Quickstart

1. Set up an account on the Transport Open Data Hub
2. Create a new application to get an API key: https://opendata.transport.nsw.gov.au/applications
3. Add the Trip Planner APIs to the application's selected APIs.
4. Copy the API Key for later use

You will need Node.js installed. Whilst the script was written and tested with Node.js v8.x, it may work on other versions too. YMMV.

git clone https://github.com/jxeeno/waratah-occupancy.git
cd waratah-occupancy
npm i
TFNSW_API_KEY=<your Open Data API key> node waratahOccupancy.js