PTV Timetable API Frequently asked questions
Q1. What does the PTV Timetable API do?
Q2. Who is the PTV Timetable API for?
Q3. Can I use the API to download all the timetable data?
Q4. What's the difference between Version 2 and Version 3 of the PTV Timetable API?
Q5. What's the difference between the PTV Timetable API and the PTV GTFS dataset?
Q6. Can I use outputs from the PTV GTFS dataset with the PTV Timetable API?
Q7. Are real-time data available?
Q8. Are Night Network data available?
Q9. Why are some of my timetable results different to those the PTV journey planner provides?
Q10. What programming languages can I use with the API?
Q1. What does the PTV Timetable API do?
A. The PTV Timetable API provides a way to directly and dynamically access the most up-to-date stop, line, disruption and timetable data held by PTV (including real-time data for train, tram and bus services, where this is made available to PTV). By creating an API we're increasing the opportunities for developers to take our data and re-use it in innovative ways.
Q2. Who is the PTV Timetable API for?
A. Our API is for everyone who wants to take our data and re-use it in a web or smartphone app.
Q3. Can I use the API to download all the timetable data?
A. The API is not designed to download all the timetable data at once. It works most effectively when used dynamically within an app as that is the way to guarantee you’re always accessing – and providing – the most up-to-date data.
To access static dumps of timetable data check out the PTV Timetable and Geographic Information – GTFS dataset on the DataVic website.
Q4. What's the difference between Version 2 and Version 3 of the PTV Timetable API?
A. Version 2 of the PTV Timetable API was developed in response to a number of PTV’s operational requirements. The APIs were developed in an organic way to address specific business needs and problems.
Version 3 of the PTV Timetable API has been designed in a holistic and more strategic fashion. The APIs have been designed to return individual objects; the API structure is simplified and terminology has been streamlined.
Q5. What's the difference between the PTV Timetable API and the PTV GTFS dataset?
A. Both the PTV Timetable API and the PTV GTFS dataset provide public transport data that includes static timetable data.
The PTV Timetable API provides dynamic access to public transport data, including real time data (where it is available), disruption information and retail ticket outlet data.
The PTV GTFS dataset, on the other hand, is a set of static public transport data files in the GTFS format; it doesn't include real time, disruption or retail ticket outlet data, but it does include shapes data which can be used to create map routing.
The PTV Timetable API and the PTV GTFS dataset can be used independently or to complement each other.
Q6. Can I use outputs from the PTV GTFS dataset with the PTV Timetable API?
A. Yes – but only through the following APIs:
- Version 2: Specific Next Departures (GTFS Input) API and Stop Facilities (GTFS Input) API
- Version 3: Departures API (both calls)
Q7. Are real-time data available?
A. The PTV timetable API includes real-time data for metropolitan train, tram and bus services in Melbourne (where these data are made available to PTV). Work to deliver real time data for regional bus is continuing progressively.
PTV gets real-time data through a number of disparate systems via the public transport operators.
Q8. Are Night Network data available?
A. Yes. Night Train and Night Tram data are included in metropolitan train and tram services data, respectively, while Night Bus is a separate route type.
Q9. Why are some of my timetable results different to those the PTV journey planner provides?
A. The PTV journey planner is coded with a number of business rules that reflect public transport operational requirements, for example, requiring passengers to board a regional train half an hour before it is due to leave.
The API accesses raw data, not Journey planner results. Your timetable results will reflect the actual scheduled time and/or the relevant real time data.
Q10. What programming languages can I use with the API?
A. The PTV Timetable API can work with all programming languages. The API uses a programming language-agnostic interface, so as long as the language you're using supports HTTP protocols, you can use our API.