Log inRegister
Log inRegister
Colour Stripe
Mobile Colour Stripe

Register and log in to the Open Data Hub and Developer Portal
Creating and managing your application
Accessing APIs
Accessing static datasets and resources

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

You need to register and log in to create an application and access our APIs.

How to Register

  1. At the top of the page, above BROWSE DATA, click REGISTER
    Image of the home page header 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. Click CREATE NEW ACCOUNT
    Image of the user account creation page
  3. A welcome email will be sent to you with your account details and a link to set your password. Click on the link, or copy and paste it into your browser
  4. Set your password and click LOG IN
  5. Your account details page will show. Review your account details, and click Save

How to Log In

  1. On the home page of the Transport for NSW Open Data Hub click LOG IN
    Image of the home page header highlighting the login button
  2. Enter your login details, username and password, and click the ‘LOG IN’ button
    Image of the user login page

Creating and managing your application

Once you have registered and logged in, you can create an application and access API keys.

Create your application

  1. Once logged in, you will be taken to the Data Catalogue. At the top of the screen, hover over (don't click) MY ACCOUNT and select Applications from the drop down menu
    Image of the applications page highlighting the add application button
  2. Click +ADD APPLICATION
    Image of the application creation page
  3. Fill in the required fields of the Create Application form. Click SAVE when complete
    Image of the application creation screen
  4. Details of your application will appear
    a) To make changes, or to delete the application, click Edit
    b) To return to the Applications page, click Back to Applications
    Image of the application screen showing the details for the newly created application
  5. You will now be able to see your application on the Applications page
    Image of the applications screen showing a list of your apps

Manage your application

  1. At the top of the screen, hover over (don't click) MY ACCOUNT and select Applications from the drop down menu
    Image of the applications page highlighting the add application button
  2. Applications you have created will appear in the list. Click Edit next to an application to view or change details or settings
    Image of the applications page highlighting the edit application button
  3. Make the required changes to your application, then click SAVE
    Image of the application details screen

Accessing APIs

Using your application and API key, you can interact with our APIs, see query results and develop your apps. APIs can be accessed through the Data Catalogue or the API Explorer. 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 the home page header highlighting the browse data button
  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 APPLY
    Image of the data catalogue highlighting the search function
  4. Click on the API to see details and resources
  5. Click EXPLORE API next to the resource you want to use to open it in the API Explorer
    Image of the dataset details screen highlighting the explore api button
  6. Set the Authentication type as API Key, and choose an application
  7. Under the API key, there is a list of operations for that resource. Click Expand Operations to see the resource’s details and response messages
    Image of the API explorer options for an API highlighting the API key settings and operations
  8. Scroll to the bottom of the command you want to trigger, and click Try it out! to get a response from the API. A curl command, the request URL, response body, response code and response headers will display
    Image of the API explorer highlighting the try it out button

Use the API explorer

The API Explorer displays information about the API, resource, method, and parameters you select for a query. When you submit a query, the API Explorer displays the query string and the API results. The API Explorer can also display error messages.
1. At the top of the screen, hover over (don’t click) DEVELOPERS and select API Explorer from the drop down menu
Image of the home page header highlighting the developers data button
2. A list of available datasets and resources will show on the left hand side. Click on a resource to see details and operators
Image of the API explorer highlighting the list of datasets on the left hand sidebar
3. Set the Authentication type as API Key, and choose an application
4. Under the API key, there is a list of operations for that resource. Click Expand Operations to see the resource’s details and response messages
Image of the API explorer options for an API highlighting the API key settings and operations
5. Scroll to the bottom of the command you want to trigger, and click Try it out! to get a response from the API. A curl command, the request URL, response body, response code and response headers will display
Image of the API explorer showing the query response, request URL and curl command

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
Image of the home page header highlighting the browse data button
2. In the Data Catalogue, you can:
a) Search for the dataset or resource you want to use (shown in this example)
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 APPLY
Image of the data catalogue highlighting the search function
4. Click a dataset or resource to see details
5. If you want to download a resource, click DOWNLOAD next to the resource. If you want to view more details about the resource, click EXPLORE
Image of the dataset details screen that contains a static file
6. If you want to download the resource after viewing more details, click on the resource or click Download at the top of the screen
Image of the static file resource details highlighting the download button

What's next? You can download and read the documentation, learn about API Basics and connect with us via the forum.