User Guide | TfNSW Open Data Hub and Developer Portal

Register and log in to the Open Data Hub and Developer Portal

You need to register and log in to access our APIs.

How to Register

1. At the top of the page, above BROWSE DATA, click REGISTER

Image of the Open Data Hub page with a red square highlighting the Register button

2. Fill in the registration form, including all required fields. Read the Terms and Conditions of Use then scroll down and click Accept Terms & Conditions of Use. Validate reCAPTCHA button and Click CREATE ACCOUNT

Image of Open Data Hub registration page with red square highlighting the Terms and Conditions scroll down button, a red square highlighting the reCaptcha box and a red square highlighting the create account box

How to Log In

1. On the home page of the Transport for NSW Open Data Hub click LOG IN

Image of the Open Data Hub page with a red square highlighting the login button

2. Enter your login details, username and password, and click the ‘LOG IN’ button

Image of the Open Data Hub login page with the login button highlighted

3. Once logged in, you will be taken to the Data Catalogue.

Image of Open Data Hub Data Catalogue page

Creating A New APl Key

To access APIs or download datasets you need an API Key.

Once logged in, click on your user profile icon
Select 'API Tokens', enter name in the text box and click 'CREATE API TOKEN' to create new key
New API key will be created, save this key in a secured location as you won't be able to see this key again in ODH

Accessing APIs

Using your API key, you can interact with our APIs, see query results and develop your apps. APIs can be accessed through the Data Catalogue. You must be logged in to interact with the APIs.

Browse the data catalogue

1. At the top of the page, click BROWSE DATA. If you have just logged in, the Data Catalogue will open automatically.

Image of Open Data Hub page, with a red square highlighting the Browse Data menu item

2. In the Data Catalogue, you can:

a) Search for the API you want to use (shown in this example)

b) Browse through all APIs if you aren't sure which API you want to use

3. Enter the name, or part of the name, of the API you want to use in the search bar and click the search button

Image of the data catalogue page with realtime entered in the search bar and a red square highlighting the search button

4. Click on the API to see details and resources

5. Click EXPLORE next to the resource you want to use to open it in the API Console

Image of the dataset details screen with red box highlighting the explore button

6. Click the AUTHORIZE button to add your api key

Image of the API console page with a red box highlighting the Authorise button

7. Enter your api key and remember to add the word 'apikey' with a space before the token. Click AUTHORIZE then CLOSE

Image of the authorise APIkey form with text entered in the value tab and a red square highlighting the Authorise box

8. You can now view a list of feeds for the resource. Click down arrow button to see the resource’s details and response messages then hit the TRY IT OUT button

Image of the API consul page with a red square highlighting the resource drop down arrow and a red square on the try it out button

9. Select debug is true from the drop down menu then EXECUTE

Image of the API console resource page with a red box highlighting the debug drop down menu and a red box highlighting the execute button

A curl command, the request URL, response body, response code and response headers will display

Image showing the API console resource results page

Accessing static datasets and resources

Static datasets and resources are available for download in the Data Catalogue

1. At the top of the page, click BROWSE DATA. If you have just logged in, the Data Catalogue will open automatically

2. In the Data Catalogue, you can:

a) Search for the dataset or resource you want to use

b) Browse through all datasets and resources if you aren’t sure what you want to use

3. Enter the name, or part of the name, of the dataset or resource you want to use in the search bar and click the search button

Image showing the Open Data Hub Data Catalogue with a search term in the search bar and a red square highlighting the search button

4. Click a dataset or resource to see details

5. Hover over the EXPLORE button next to the resource. If you want to download a resource, click DOWNLOAD. If you want to view more details about the resource, click MORE INFORMATION

Image of a resource with a red square highlighting the More Information and Download drop down menu

6. If you want to download the resource after viewing more information, click on the resource URL or click DOWNLOAD at the top of the screen