User Guide

A step-by-step guide to creating an API key and accessing APIs. 

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

  1. Register for an account and log in to the Open Data Hub

Create an API Key

  1. Once logged in, click on your user profile icon

  2. Select 'API Tokens', enter name in the text box and click 'CREATE API TOKEN' to create new key

  3. A new API key will be created. Save this key in a secure location as you won't be able to see it again.

Accessing APIs

  1. Access APIs through the data catalogue. You must be logged in to interact with our APIs. 

  2. Search for APIs by category or keyword

  3. Click on the API to see details and resources 

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

  5. Click the AUTHORIZE button to add your API key

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

  7. 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.

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

  9. Curl command, the request URL, response body, response code and response headers will display

Accessing static datasets and resources

  1. Static datasets and resources are available for download in the data catalogue 

  2. Click a dataset or resource to see details 

  3. 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.

  4. 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

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