AURIN HACKATHON GUIDE

ENHANCE YOUR HACK WITH THOUSANDS OF SPATIAL DATA SETS

AURIN is the single largest national resource for accessing and interrogating thousands of datasets, spanning the physical, social, economic, and ecological aspects of Australia’s cities, towns and communities.

Data spanning population and demographics, transport and infrastructure, health and well-being, housing and property, energy and utilities, education, economy and the built environment. All free, clean, spatialised, harmonised and ready to hack!

Data hackers can access the data they need via our Hackthon API. The API provides programmatic access to thousands of CC-BY licensed datasets. CC-BY licenses allow you to share (copy and redistribute the data in any medium or format); and / or adapt (remix, transform, and build on), for any purpose.

ACCESS THE AURIN HACKATHON API

To register to use the AURIN Hackathon API please read and accept the  API Terms of Use and fill out the registration form.  You will be issued with an API key.  You cannot share your key.  Each user of the API key must read and accept the terms of use and register.

BROWSE THE DATA

First we recommend you browse our Data Discovery to ascertain which datasets will be most helpful for your hacking.

HOW DO I USE THE API?

Your Hackathon API key will allow you to programatically access available datasets via any web browser (or javascript code)

 

It’s easy to construct a WFS query to download data from the AURIN API programmatically.

For example:

http://openapi.aurin.org.au/wfs?
version=1.1.0&
request=GetFeature&
typeNames=
insert_dataset_openapi_ID&
outputFormat=csv

  1. Browse the Data Discovery for your dataset and copy the “AURIN Open API ID” value in the highlighted text above.

In this example we take the City of Melbourne CLUE data and insert the API ID into the WFS query:

http://openapi.aurin.org.au/wfs?version=1.1.0&request=GetFeature&type
Names=aurin:datasource-VIC_LGovt_COM-UoM_AURIN_DB_com _clue_business_establishments_name_industry_2004&outputFormat=csv

2. Then copy-paste this WFS query into your browser (or script) and execute.

3. When prompted, enter the user name and password your received in your AURIN Hack email:

ADDITIONAL USES

If you are doing spatial analysis we recommend QGIS – a free open source GIS software.  If you are running statistical analysis we recommend using R.

We have tutorials to step you through how to use our API with QGIS and R:

ATTRIBUTE AND SHARE YOUR HACK!

If you use any AURIN data in your hack be sure to attribute the AURIN API and the original owner of the data (data custodian).

This is the standard attribution format:

[Data Source Organisation], ([Year]): [Dataset Title]; accessed from [[AURIN Portal]/AURIN Workbench/[name AURIN sub-site]] on [date of access]

The full dataset attribution can be found in the “Additional information” section of the data description section in the Data Discovery Catalogue

For example:

Your attribution should look like this:

Local Government of Victoria – City of Melbourne (2018):  City of Melbourne CLUE Business Establishments Names and Industries (Point) 2014; accessed from AURIN API on 28/07/2019.

SHARE YOUR HACK ON SOCIAL MEDIA!

Use the hashtags

#HackAURIN

#spatialintelligence