ptv-api-helper v1.0.9

PTV API Helper

A NodeJS library for the Victorian Public Transport Timetable API.

Created as part of a bootcamp project this isn't intended as a 1:1 wrapper, instead covering and simplifying most of the common actions that a timetable app would need such as searching for stops, getting departures and disruptions etc.

Usage

You'll need to register for an API key before you can start making requests. You can find out about how to do this (and learn more about the API itself) here.

Install the module

npm install ptv-api-helper\ or\ yarn add ptv-api-helper

Example (Finds all trains and busses in the suburb of Batman)

const ptvClient = require('ptv-api-helper')(1000 (your dev id), 'your api key here');

ptvClient.searchForStopByLocationAsync('Batman', [0, 2])
.then(stops => stops.forEach(s => console.log(s.name)))
.catch(ex => console.log(ex));

What can I do?

TODO: Full documentation.

Here is an overview of the methods currently available:

getAllTransportTypesAsync() - Gets a list of all modes of transport supported by the API.

getDetailedStopInfoAsync(stopId, transportType, options = { includeDisruptions: true }) - Get information on a stop's ammenties and accessability facilities, and optionally any drisruptions. You should generally take any ammentity/accessability info for non-premium stations with a grain of salt. For example, many train stops list having a toilet, which may be technically true, but is either permamently locked or only accessable during peak hours.

getDeparturesForStopAsync(stopId, transportTypeId, options = { startDateUTC: '2021-08-17T14:48:52.356Z', directionId: 15, maxResults: 10, includeDisruptions: true, includeDirections: true, preSortDepartures: true }) - Gets departures for a stop and optionally overviews for lines (lines) and disruptions. By default includes all lines in all directions. Note that maxResults is the number of departures per line. Includes live arrival times for services that support it.

getDeparturesForARunAsync(runRef,transportType) - Gets departures for all stops on a particular service, ordered by first to last. Includes live arrival times for services that support it.

calculateFareAsync(zoneStart, zoneEnd) - Gets myki fare prices for traveling between two zones.

getStopsOnALineAsync(lineId, transportType, directionId) - Gets all stops on a line in a particular direction, ordered from first stop to destination.

searchForStopByLocationAsync(latitude, longitude, transportFilters = [0,1,2,3,4], maxDistance = 1000) - Gets all stops within a location.

searchForStopBySuburbAsync(suburb, transportFilters = [0,1,2,3,4]) - Gets all stops within a suburb.

getStopsOnALineAsync(lineId, transportType, directionId) - Gets all stops for a line in a particular direction.

getDirectionsForLineAsync(lineId) - Gets line directions for a line (ie. Flinders Street to Weribee, Brunswick East to St Kilda Beach etc.)

getFutureDisruptionsForStopAsync(stopId, transportType) - Gets future disruptions for a stop.

getCurrentDisruptionsForStopAsync(stopId, transportType) - Gets current disruptions for a stop.

MIT License

Copyright (c) 2021 Corey Ralli

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This project is not associated or endorsed with PTV (Public Transport Victoria) in any way, shape or form. PTV Timetable API data licensed from Public Transport Victoria under a Creative Commons Attribution 4.0 International Licence.