Frequently Asked Questions
Open data is the idea that public information should be accessible, used, modified and shared by anyone for any purpose without restrictions. Open data should be both technically and legally open: technically open in that it is available and accessible to the community, and legally open in so far as there are appropriate licensing frameworks in place to facilitate its release, use and reuse by the community.
A dataset is a collection of related sets of information, which shows relationships between categories and variables. An example of a dataset is a table of all train stations in NSW, with a set of information about each station, such as platform numbers.
Datasets contain individual resources, as well as metadata. Metadata contains information about the dataset. Resources are the files within the dataset. A dataset may have multiple resources such as APIs, links or images.
Application Programming Interfaces (APIs) are a set of rules and instructions for how software can interact with a dataset. APIs allow flexibility in how information within a dataset is accessed, typically so that users can select only a specific, relevant subset of the information. APIs are usually connected to datasets that are updated in real-time.
TfNSW offers a number of datasets and APIs for all public transport modes and roads. These include static timetable information, as well as live and real time information (feed data). If you have an idea of data that you think would be useful, let us know on the Forum.
Making more government data available to the community is a key commitment of the NSW Government, is a priority of the NSW Government ICT Strategy, and is a driver of the NSW digital economy. By providing data to the community, we can improve transparency and accountability, enable evidence-based policy decisions and provide a platform for innovation. TfNSW has provided open data since the launch of the TDX Program in 2009. TfNSW is committed to fostering innovation in the digital economy, and is excited to see the innovations and creations the community produce using our data.
The Open Data Program replaced the TDX Program in April 2016. The Open Data Program is providing access to a broader range of information than the TDX Program, including the provision of APIs.
The NSW Government has made a commitment to opening more data to the public and many NSW Government agencies have begun releasing open data. Examples include Family and Community Services, Property NSW and the Information and Privacy Commission. For a full list of NSW Government agencies providing data to the public, please visit data.nsw.gov.au Open data is not only a NSW initiative and is quickly becoming a priority for governments across the world, including Europe, North America and across Australia too! To find out more about our federal open data please visit data.gov.au.
The Open Data Hub and Developer Portal is where you will find all publicly available TfNSW open data. It provides access to all APIs and datasets, as well as developer information to get you started and a Forum to contact us.
All data provided on the Open Data Hub and Developer Portal is owned by TfNSW.
The possibilities for using TfNSW data are endless and already we have seen many innovative ideas! The data can be used to produce maps and reports, or used by policy makers and transport planners to gain insights, for analysis and informed decision making. Most commonly, the data is used to create transport apps, both for public transport modes and roads. You can check out some of the apps developed using TfNSW data in our showcase.
We derive and directly source our data from operational systems within TfNSW. While we cannot guarantee the complete accuracy of the data, it is the best source of data for our transport services.
We are constantly working to release new datasets and APIs. You can request data you want to see released in the Forum. Be sure to read previous requests first, as someone else may have requested the data and we might be working to release it.
TfNSW sets out to provide as much data as possible, and some datasets need to be cleansed before being released. This may be due to safety, commercial concerns or protecting the privacy of our customers. These datasets need to be identified, prioritised and made available in the appropriate format.
No, the Open Data Hub and Developer Portal is designed to provide data for you to use and is not a hosting service.
Currently, only TfNSW can publish data to the Open Data Hub and Developer Portal.
You can use your own API, but you will need to host your own API or use another host.
You can explore all available APIs in the Data Catalogue on the Open Data Hub. You can find basic API information on the Get Started page.
The Open Data Hub and Developer Portal is accessible to anyone. While access to APIs is designed specifically for developers with technical knowledge, we also offer the ability to download datasets which requires no technical knowledge. Downloadable datasets are often used by researchers who are interested in TfNSW data. If you get stuck, the Forum is available to everyone. Through the Forum the community and TfNSW staff can assist with technical queries and general questions about the data.
Static type data is available in text formats, usually in a zip file. Feed data is available via APIs in specific formats. Check the Data Catalogue for more information.
The new Open Data Hub and Developer Portal, does not display code samples. A cURL command is provided to test your API details.
The use of TfNSW data should not be seen as an endorsement, sponsorship and/or partnership and you should never brand your product in a way that states or implies this. Visit the Marketing page for full details of what you can and cannot use to brand your product.
For any dataset or API with a Creative Commons by Attribution 4.0 licence, you may reuse and redistribute the data. Please check the licence for the data you are using.
The creator of the application can share the API credentials (API key or OAuth credentials) with other users manually. There is no system functionality enabled to share apps or API credentials. **Please note:** you should never share your user credentials (username and password) with anyone.
You can request to have your product included on our Showcase by emailing OpenDataProgram@transport.nsw.gov.au with the following information: * An overview of your app or website * Features or services you offer * A high resolution logo * Screenshots of your app or website.
The Timetables Complete GTFS and TransXChange APIs return large files, and is unlikely to work in the API Explorer (or when Explore API is selected in the Data Catalogue). You can download the zip files by selecting Download in the dataset. Should you wish to retrieve the files on a regular basis, you can use your API key to retrieve it programmatically.
We recommend using API Key authentication as it is simple and has fewer issues than the OAuth 2 authentication. If you are using OAuth 2 authentication you may continue to do so.
The GTFS-realtime ferry feed reports all current and future vehicle positions. This causes a "trail" of vehicles to appear while the ferry is moving. It's possible to filter out to only show the current trip's vehicle position. Use vehicle > id as the unique identifier. Since the ferry feed no longer reports vehicle positions once a trip has been completed, you can cross reference with the GTFS-static data to identify which trip begins the earliest (i.e. has the earlieststop_times.txt entry).
To access TfNSW data you will need to register and sign in via the Open Data Hub and Developer Portal. The register button can be found at the top of the page.
All available datasets and APIs can be found in the Data Catalogue. If you can’t find what you are looking for, you can post a question in the Forum. Be sure to read previous posts before posting a question, someone else may have already asked.
You can request additional data through the Forum. Be sure to read previous requests for data, as the data you need may have been requested and we might be working on it! We review these requests constantly and work with data curators across TfNSW to make suggested data available.
The Documentation page contains lots of information to help you understand our data.
You can post questions in the Forum, where the community and TfNSW staff can assist with your query. Be sure to read previous posts before posting a question, the answer may already be there.
You can search for all our available APIs and datasets in the Data Catalogue on the Open Data Hub.
We have a number of channels to help you: If you need help with data or technical questions, please read the Getting Started and Documentation pages. If you still have questions, you can post a question in the Forum. Be sure to read previous posts before posting a question, the answer may already be there. If you have lost your password or username, or need to report an outage or issue, send an email to OpenDataHelp@transport.nsw.gov.au. We aim to respond to requests within 3 – 5 business days. Be sure to add as much information as you can to help us get back to you more quickly.
Data issues and outages are shown on the Status page. Check the Status page first to see if it has already been reported. If the issue or outage isn’t displayed on the Status page, email OpenDataHelp@transport.nsw.gov.au with details of the issue or outage. Please be aware that some issues and outages cannot be fixed quickly, and may take time to resolve. You should always report issues and outages as soon as possible, so we can investigate and let the relevant people know.